mdbook-man
| Crates.io | mdbook-man |
| lib.rs | mdbook-man |
| version | 0.1.0 |
| source | src |
| created_at | 2021-08-23 18:37:52.743544 |
| updated_at | 2021-08-23 18:37:52.743544 |
| description | A backend for mdBook that generates man pages |
| homepage | https://github.com/vv9k/mdbook-man |
| repository | https://github.com/vv9k/mdbook-man |
| max_upload_size | |
| id | 441319 |
| size | 61,682 |
Wojciech Kępka (vv9k)
documentation
README
mdbook-man
Generate man pages from mdBooks!
Usage
To use mdbook-man you'll first need to install it with:
$ cargo install mdbook-man
And add the following to your book.toml:
[output.man]
The man page will be printed to standard output when running mdbook build.
Configuration
This are the available configuration parameters:
[output.man]
output-dir = "/some/path/to/a/directory" # this directory doesn't have to exist, it will be created automatically
split-chapters = true # By default all chapters will be joined as one single man page,
# to override this set this parameter to true.
Example
You can check out the Rust Programming Language book compiled as a man page here.
$ wget https://vv9k.github.io/mdbook-man/book.man
$ man -l book.man