The "markdown-yaml-lint" is a yaml lint checker specifically for checking the yaml syntax in a markdown file.
This extension checks the syntax of the yaml code embedded in a markdown file in a yaml snippet.
Install yamllint package in the machine before applying this extension in usage.
If this extension is used without installing yamllint package in the system, this may result in the below error,
Open a markdown file having yaml code in a yaml code block and select 'md-yaml-lint' from vscode command palette, if any syntax issues in the yaml code block, the extension will open a console and displays the issues with Line Numbers.
example of yaml code:
If any syntax issues in the yaml code blocks in a markdown file the extension will open terminal and display the issues along with line numbers, if the yaml code block is fine and doesn't have any issues then the extension displays as "the code block is valid".
example of lint check results on console:
Make sure the extension is selected on a .md file else vscode issues a warning as shown below.
Working with Markdown
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
For more information