https://github.com/vv9k/mdbook-man

Generate manual pages from mdBooks!
https://github.com/vv9k/mdbook-man

manpages manual mdbook

Last synced: 13 days ago
JSON representation

Generate manual pages from mdBooks!

• Host: GitHub
• URL: https://github.com/vv9k/mdbook-man
• Owner: vv9k
• License: mit
• Created: 2021-08-22T19:17:56.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2022-10-06T05:17:26.000Z (about 2 years ago)
• Last Synced: 2024-04-24T04:52:32.268Z (7 months ago)
• Topics: manpages, manual, mdbook
• Language: Rust
• Homepage:
• Size: 539 KB
• Stars: 27
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mdbook-man

[![Build Status](https://github.com/vv9k/mdbook-man/workflows/CI/badge.svg)](https://github.com/vv9k/mdbook-man/actions?query=workflow%3A%22CI%22)

Generate man pages from mdBooks!

## Usage

To use **mdbook-man** you'll first need to install it with:

```console

$ cargo install mdbook-man

```

And add the following to your `book.toml`:

```toml

[output.man]

```

The man page will be printed to standard output when running `mdbook build`.

## Configuration

This are the available configuration parameters:

```toml

[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.

filename = "custom-book-filename.man" # override the default filename if the `output-dir` is also specified.

```

## Example

You can check out [the Rust Programming Language book](https://doc.rust-lang.org/book/) compiled as a man page [here](https://vv9k.github.io/mdbook-man/book.man).

```console

$ wget https://vv9k.github.io/mdbook-man/book.man

$ man -l book.man

```

## License

[MIT](https://github.com/vv9k/mdbook-man/blob/master/LICENSE)