Follow markdown standards with markdowlint markdownlint-cli2 and nvim-lint
The tool used in this video markdownlint or markdownlint-cli2 does not necessarily have to be used with neovim, you can use it on your CLI and based on what I read on the github repo, other editors too.
In the video we will also configure an additional plugin mfussenegger/nvim-lint which allows yo to globally set a .markdownlint.yaml file, as opposed to have a file on each project. This markdownlint.yaml file is used to manage or customize markdown rules, as you will probably will like to disable some of them.
This video focuses on setting it up for Neovim, as that's the editor that I use, but it will give you ideas to implement it in your existing solution
The text below comes from the repo, but it will help you understand what all of this is about:
"markdownlint is a static analysis tool for Node.js with a library of rules to enforce standards and consistency for Markdown files. It was inspired by - and heavily influenced by - Mark Harrison's markdownlint for Ruby. The initial rules, rule documentation, and test cases came directly from that project
The Markdown markup language is designed to be easy to read, write, and understand. It succeeds - and its flexibility is both a benefit and a drawback. Many styles are possible, so formatting can be inconsistent. Some constructs don't work well in all parsers and should be avoided. The CommonMark specification standardizes parsers - but not authors."
Besides this, I also use prettier to autoformat my files, and a lot of other markdown tools tips and tricks
If you find this video helpful and want to support me
https://ko-fi.com/linkarzu
Follow me on twitter
https://x.com/link_arzu
My complete Neovim markdown setup and workflow in 2024
• My complete Neovim markdown setup and work...
View and paste images in Neovim like in Obsidian
• View and paste images in Neovim like in Ob...
Fold markdown headings in Neovim with a keymap
• Fold markdown headings in Neovim with a ke...
Here are my dotfiles, star the repo!
https://github.com/linkarzu/dotfiles-...
0:00 - markdownlint warnings demo
1:18 - what is markdownlint
2:20 - importance of a linter
3:34 - install markdownlint-cli2
4:43 - configure markdownlint yaml file
6:45 - configure nvim-lint plugin
7:45 - ignore markdownlint inside files
8:55 - want to learn prettier