mdast-lint-blank-lines-1-0-2
This mdast-lint rule was created for free-programming-books-lint to enforce free-programming-books formatting guidelines.
This rule ensures that a file has
- 2 empty lines between last link and new section
- 1 empty line between heading & first link of its section
- 0 empty line between two list items
- 1 empty line at the end of each .md file
<!-- Invalid -->
[...]
* [An Awesome Book](http://example.com/example.html)
### Example
* [Another Awesome Book](http://example.com/book.html)
* [Some Other Book](http://example.com/other.html)
<!-- Valid -->
[...]
* [An Awesome Book](http://example.com/example.html)
### Example
* [Another Awesome Book](http://example.com/book.html)
* [Some Other Book](http://example.com/other.html)
Using the rule
.mdastrc
Via npm install -g mdast
npm install -g mdast-lint
npm install mdast-lint-blank-lines-1-0-2 # local install!
Then, set up your .mdastrc
:
{
"plugins": {
"mdast-lint": {
"external": ["mdast-lint-blank-lines-1-0-2"]
}
}
}
Now you can use the following command to run the lint:
mdast --no-stdout xxx.md
Via CLI
npm install -g mdast
npm install -g mdast-lint
npm install -g mdast-lint-blank-lines-1-0-2 # global install!
mdast --no-stdout -u mdast-lint="external:[\"mdast-lint-blank-lines-1-0-2\"]" xxx.md
Note that the lint=<lint_options>
option only works with mdast >= 1.1.1
.