Awesome
remark-lint-blank-lines-1-0-2
This remark-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
Via .remarkrc
npm install -g remark-cli
npm install remark-lint remark-lint-blank-lines-1-0-2
Then, set up your .remarkrc
:
{
"plugins": [
"lint",
"lint-blank-lines-1-0-2"
]
}
Now you can use the following command to run the lint:
remark xxx.md
Via CLI
npm install -g remark-cli
npm install remark-lint remark-lint-blank-lines-1-0-2
remark -u lint -u lint-blank-lines-1-0-2