4 releases (breaking)
0.4.0 | Sep 30, 2023 |
---|---|
0.3.0 | Aug 8, 2023 |
0.2.0 | Jul 18, 2023 |
0.1.0 | Jul 11, 2023 |
#1632 in Text processing
454 downloads per month
17KB
129 lines
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-->
Dependencies
~12–23MB
~341K SLoC