https://github.com/vhf/remark-lint-blank-lines-1-0-2

remark-lint-blank-lines-1-0-2
https://github.com/vhf/remark-lint-blank-lines-1-0-2

Last synced: about 2 months ago
JSON representation

remark-lint-blank-lines-1-0-2

• Host: GitHub
• URL: https://github.com/vhf/remark-lint-blank-lines-1-0-2
• Owner: vhf
• Created: 2015-12-18T10:02:21.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2019-08-04T10:10:24.000Z (about 5 years ago)
• Last Synced: 2024-04-13T16:35:12.396Z (5 months ago)
• Language: JavaScript
• Homepage:
• Size: 54.7 KB
• Stars: 6
• Watchers: 4
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# remark-lint-blank-lines-1-0-2

This [remark-lint](https://github.com/wooorm/remark-lint) rule was created for [free-programming-books-lint](https://github.com/vhf/free-programming-books-lint) to enforce [free-programming-books](https://github.com/vhf/free-programming-books) [formatting guidelines](https://github.com/vhf/free-programming-books/blob/master/CONTRIBUTING.md#formatting).

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

```Text

[...]

* [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)

[...]

* [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`

```bash

npm install -g remark-cli

npm install remark-lint remark-lint-blank-lines-1-0-2

```

Then, set up your `.remarkrc`:

```JSON

{

  "plugins": [

    "lint",

    "lint-blank-lines-1-0-2"

  ]

}

```

Now you can use the following command to run the lint:

```bash

remark xxx.md

```

### Via CLI

```bash

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

```