Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ilyatitovich committed Apr 19, 2024
1 parent eeee704 commit 15b1427
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,19 @@

[remark-lint](https://github.com/remarkjs/remark-lint) plugin to ensure that your Markdown headings capitalization is correct.

The plugin finds the TOC and checks titles and URLs against existing titles in the document.
**The plugin checks:**

- The ratio of the number of sections in the document and the TOC (to ensure consistency when sections are added or removed).
- The presence of a section in the TOC (to detect when a section is missing or incorrectly listed).
- Correctness of URLs (ensuring they are generated correctly using a slugger for GitHub).
- The order of sections in the TOC compared to the document.
- Ensuring that the sections in the TOC maintain the correct hierarchy based on the headings in the document.

## Install

```sh
npm install remark-lint-check-toc
```

## Usage

Expand Down

0 comments on commit 15b1427

Please sign in to comment.