mdbook-chapter-list

Crates.iomdbook-chapter-list
lib.rsmdbook-chapter-list
version0.1.0
sourcesrc
created_at2024-01-09 23:22:43.665922
updated_at2024-01-09 23:22:43.665922
descriptionmdbook preprocessor for listing subchapters.
homepage
repositoryhttps://github.com/bradjc/mdbook-chapter-list.git
max_upload_size
id1094730
size32,698
Brad Campbell (bradjc)

documentation

README

Chapter Listing plugin for mdbook

The chapter-list preprocessor supports adding sub-chapter lists to documents.

Example

With a SUMMARY.md file like:

- [Zoo Animals](./zoo.md)
  - [Large Cats](./cats.md)
    - [Lion](./lion.md)
    - [Tiger](./tiger.md)
  - [Zebra](./zebra.md)
  - [Turtle](./turtle.md)

Then include <!-- chapter-list --> in the zoo.md markdown file:

## Animals in the Zoo:

<!-- chapter-list -->

The zoo.md file would be updated to:

## Animals in the Zoo:

1. [Large Cats](./cats.md)
   1. [Lion](./lion.md)
   2. [Tiger](./tiger.md)
2. [Zebra](./zebra.md)
3. [Turtle](./turtle.md)

Installation

Firstly add the following to your book's manifest file (usually book.toml)

[preprocessor.chapter-list]
Commit count: 0

cargo fmt