mdBook

Byline:

mdBook is a utility to create modern online books from Markdown files.

Key links

• 🏠 Homepage: https://rust-lang.github.io/mdBook/
• 👨‍💻 Repo:

Uncategorized Links

• mdBook Quickstart
  • GitHub template repo
• Command-line docs
• SUMMARY.md
  • File in mdBook’s own site as an example.
• Configuration
  • In the docs for help on fields.

The docs say it is “Like Gitbook but implemented in Rust”.

There is a print button as well if you need to make a PDF or print a hardcopy.

There is a button on a site to change themes.

Structure

How mdBook projects are structured.

• src/
  • SUMMARY.md - sidebar contents page.
  • *.md - additional Markdown files as your book’s content.
• book.toml - mdBook’s config file.
• books/ - output directory.