An mdbook preprocessor for defining and optionally hiding private sections and chapters in your book.
Installation
sh
cargo install mdbook-private
Configuration in book.toml ```toml
[preprocessor.private] remove = false style = true notice = "CONFIDENTIAL" chapter-prefix = "_" ```
Options Explained
- remove
(boolean): Determines whether to remove or retain sections marked as private.
- style
(boolean): Styles the private sections (when retained) using blockquote CSS.
- notice
(string): Adds a notice to styled sections at the top right corner.
- chapter-prefix
(string): If the remove
option is active, chapters with filenames prefixed with this value will be excluded.
Markdown Usage
For a hands-on example, explore the example-book
.
```
<code>md5-8243591100fa8f26a0d2b213092bd18a</code>remove
option enabled, only "Chapter 1" will be retained.```markdown ```