https://github.com/vhf/remark-lint-heading-whitespace

https://github.com/vhf/remark-lint-heading-whitespace

Last synced: 17 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/vhf/remark-lint-heading-whitespace
• Owner: vhf
• Created: 2018-02-08T19:22:05.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-02-08T19:22:12.000Z (almost 7 years ago)
• Last Synced: 2024-10-16T19:23:26.475Z (28 days ago)
• Language: JavaScript
• Size: 66.4 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# remark-lint-heading-whitespace

This is a [remark-lint](https://github.com/wooorm/remark-lint) rule.

On some keyboards, for instance the default Swiss German keyboard layout `de_CH` [QWERTZ](https://en.wikipedia.org/wiki/QWERTZ) layout, the `#` symbol is obtained using `alt-3`. Because `alt-space` inserts a [non-breaking space](https://en.wikipedia.org/wiki/Non-breaking_space), it seems easy to insert `#` by mistake while writing Markdown heading `# title`.

This leads to headings getting parsed as normal Markdown paragraphs, here `a` and `c` are normal headings, `b` and `d` have probably been typed too fast without releasing the `alt` key between `#` and `space`:

![Markdown](./a.png)

![Preview](./b.png)

This `remark-lint` rule prevents this from ever happening by throwing an error whenever such situations are detected.

## Using the rule

### Via `.remarkrc`

```bash

npm install -g remark-cli

npm install remark-lint remark-lint-heading-whitespace

```

Then, set up your `.remarkrc`:

```JSON

{

  "plugins": [

    "lint",

    "lint-heading-whitespace"

  ]

}

```

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-heading-whitespace

remark -u lint -u lint-heading-whitespace xxx.md

```