Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 1.15 KB

MDBOOK.md

File metadata and controls

54 lines (34 loc) · 1.15 KB

mdBook

Details about our mdBook setup.

Installation

To install cargo, run the following command:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

To install mdBook, run the following command:

cargo install mdbook

Install required preprocessors:

# Install mdbook-mermaid for Mermaid diagram support
cargo install mdbook-mermaid

# Install mdbook-embedify for embedding external content
cargo install mdbook-embedify

Usage

To build the book, run the following command:

mdbook build

To serve the book, run the following command:

npx serve book -p 3000

Configuration

The configuration file is located at book.toml.

We've enabled the following features:

  • Giscus: To enable comments on the book. See mdbook-embedify for more details.
  • Mermaid: To enable diagrams in the book. See mdbook-mermaid for more details.

Deployment

Deployment is handled by GitHub Actions. See: https://github.com/rust-lang/mdBook/blob/master/.github/workflows/deploy.yml