Development / Documentation
We use mdBook for this documentation.
Install
Please install these crates using cargo:
cargo install mdbook
cargo install mdbook-mermaid
cargo install mdbook-admonish
cargo install mdbook-preprocessor-graphql-playground
| Crate | Description |
|---|---|
| mdbook | Create book from markdown files. Like Gitbook but implemented in Rust |
| mdbook-mermaid | A preprocessor for mdbook to add mermaid support |
| mdbook-admonish | A preprocessor for mdbook to add Material Design admonishments |
| mdbook-preprocessor-graphql-playground | A preprocessor for mdbook to add GraphQL playgrounds |
Build only
mdbook build
Build and watch documentation locally
mdbook serve --open