I've noticed that most of the Markdown files in this project are very chaotically written and do not adhere to standard documentation writing rules in *.md files. My editor shows many errors in these files.
The Solution
Add linter configuration file for Markdown and CommonMark files. This tool is a style checker and formatting tool for the files based on the CommonMark specification. The tool is available as a command line tool and works with Prettier as well.
I can create a pull request with the necessary files that will allow you to maintain the markdown files according to the established specifications and perform formatting of all the markdown files in this project. Formatting these files will not change the content of the documents, it will only correct them according to the specifications.
These fixes are intended to maintain consistent style across all Markdown documentation files in this project.
Requirements
The Problem
I've noticed that most of the Markdown files in this project are very chaotically written and do not adhere to standard documentation writing rules in
*.md
files. My editor shows many errors in these files.The Solution
Add linter configuration file for Markdown and CommonMark files. This tool is a style checker and formatting tool for the files based on the CommonMark specification. The tool is available as a command line tool and works with Prettier as well.
See the markdownlint repository for more info.
Proposed Fixes
I can create a pull request with the necessary files that will allow you to maintain the markdown files according to the established specifications and perform formatting of all the markdown files in this project. Formatting these files will not change the content of the documents, it will only correct them according to the specifications.
These fixes are intended to maintain consistent style across all Markdown documentation files in this project.