jer/mdbook-toc
1
Fork 0
Code Actions Activity

Clarify which headers are included

Browse source
This commit is contained in:
Jan-Erik Rediger 2023-06-01 16:41:26 +02:00
parent ee15575d47
commit 9c1ad00448
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -4,13 +4,13 @@ A preprocessor for [mdbook][] to add inline Table of Contents support.
[mdbook]: https://github.com/rust-lang-nursery/mdBook
It turns this:
It turns this marker:
```md
<!-- toc -->
```
into a Table of Contents based on all top- and second-level headings of the chapter.
into a Table of Contents based on headings of the chapter following the marker.
## Installation