https://github.com/bradjc/mdbook-chapter-list

mdbook plugin to list sub-chapters
https://github.com/bradjc/mdbook-chapter-list

mdbook mdbook-plugins

Last synced: 14 days ago
JSON representation

mdbook plugin to list sub-chapters

• Host: GitHub
• URL: https://github.com/bradjc/mdbook-chapter-list
• Owner: bradjc
• License: mit
• Created: 2024-01-09T23:11:07.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-09T23:27:32.000Z (about 1 year ago)
• Last Synced: 2024-12-09T19:45:37.790Z (about 1 month ago)
• Topics: mdbook, mdbook-plugins
• Language: Rust
• Homepage:
• Size: 13.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

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 `` in the zoo.md markdown file:

```md

## Animals in the Zoo:

```

The zoo.md file would be updated to:

```md

## 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`)

```toml

[preprocessor.chapter-list]

```