mdbook-private

build crate.io downloads license

An mdbook preprocessor for defining and optionally hiding private sections and chapters in your book.

Usage

Installation sh cargo install mdbook-private

Configuration in book.toml ```toml

Default options

[preprocessor.private] remove = false style = true notice = "CONFIDENTIAL" chapter-suffix = "_" ```

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.

```

Summary


```markdown ```

Example output