Ensure your Markdown documents adhere to coding standards and best practices with features such as code block validation, proper formatting checks and more.
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
The SMD Lint extension is a powerful tool designed to help you maintain consistency and adherence to company-specific rules while writing Markdown files within Visual Studio Code. This extension follows the Markdown rules defined by OpenReplay, ensuring that your documents meet the required standards.
Features
Rule overview
Press Ctrl+Shift+P to open the command palette.
Search for "SMD Rules" and select it.
View a comprehensive list of all Markdown rules defined by OpenReplay in a separate tab.
Rule validation
Press Ctrl+Shift+P to open the command palette.
Search for "SMD Check" and select it.
Choose the specific rule you want to validate against from the provided list.
The extension will scan your Markdown file and highlight any instances where the selected rule is not followed.
Clear checks
Press Ctrl+Shift+P to open the command palette.
Search for "SMD Check" and select it.
Choose "Clear Checks" to remove all rule validation highlights from your Markdown file.
Excess repetition check
Press Ctrl+Shift+P to open the command palette.
Search for "SMD Excess Repetition" and select it.
An information modal will appear on your screen, listing any words that appear excessively (more than 50 times) in your Markdown file each separated with |.
Installation
Launch Visual Studio Code.
Go to the extensions view by clicking on the square icon in the sidebar.
Search for "SMDLint" in the extensions marketplace.
Click install to add the extension to your VSCode setup.
Usage
Open a Markdown file in Visual Studio Code.
Utilize the provided commands in the command palette (Ctrl+Shift+P) to access various features of the SMD Lint extension.
Follow the on-screen prompts and instructions to check for rule violations and maintain Markdown file quality.
Feedback and support
For any questions, feedback, or support requests, please contact us at support@smd.lint. We're here to help you get the most out of the SMD Lint extension!
Known issues
In some instances, the extension may not function optimally with Markdown files generated by external commands like npx create-react-app smd-lint. If you encounter issues with the extension while working with Markdown files created by such commands, it is recommended to delete the file and recreate it with the same content.
