https://github.com/ankitrgadiya/mdbook-hide
A preprocessor for mdbook that adds support for hidden chapters.
https://github.com/ankitrgadiya/mdbook-hide
markdown mdbook mdbook-plugin mdbook-preprocessor rust
Last synced: about 1 month ago
JSON representation
A preprocessor for mdbook that adds support for hidden chapters.
- Host: GitHub
- URL: https://github.com/ankitrgadiya/mdbook-hide
- Owner: ankitrgadiya
- License: bsd-3-clause
- Created: 2023-07-11T15:22:08.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-30T10:26:15.000Z (over 1 year ago)
- Last Synced: 2025-04-03T09:49:31.695Z (about 2 months ago)
- Topics: markdown, mdbook, mdbook-plugin, mdbook-preprocessor, rust
- Language: Rust
- Homepage: https://crates.io/crates/mdbook-hide
- Size: 27.3 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mdbook-hide
A preprocessor for [mdbook](https://rust-lang.github.io/mdBook) that adds
support for hidden chapters. The hidden chapters can be marked by adding a
special Markdown comment. Based on the config, hidden chapters can be added or
removed in the build.
## Installation
Currently, this preprocessor is only available as a crate. In future, I'll add
the binary releases as well. To install, run the command:
```sh
cargo install mdbook-hide
```
## Usage
To use the preprocessor in your mdbook, add the following section in the
`book.toml`. If the `hide` is set to true, then the hidden chapters will be
removed.
```toml
[preprocessor.hide]
hide = true
```
To mark a chapter as hidden, add this special Comment anywhere in the Markdown
file. It is better to have it at the top of the file for clarity.
```markdown
```