mdbook-hide
| Crates.io | mdbook-hide |
| lib.rs | mdbook-hide |
| version | 0.4.0 |
| created_at | 2023-07-11 15:27:47.829986+00 |
| updated_at | 2023-09-30 10:26:26.03738+00 |
| description | A preprocessor for mdbook that adds support for hidden chapters |
| homepage | |
| repository | https://github.com/ankitrgadiya/mdbook-hide |
| max_upload_size | |
| id | 913947 |
| size | 58,560 |
Ankit R Gadiya (ankitrgadiya)
documentation
README
mdbook-hide
A preprocessor for 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:
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.
[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.
<!--hidden-->