Install mdbook and mdbook-toc:
cargo install mdbook
cargo install mdbook-toc
To build book:
mdbook build
To serve locally:
mdbook serve
Specifications are written and stored in the same directory with the implementation code. Since mdbook
does not support referencing files outside of the book directory, we use a symlink to the src/specs
directory. This allows us to reference the specifications from the README.md
and SUMMARY.md
files in the src
directory.
To create a symlink:
cd src/specs
ln -s path/to/spec.md
Markdown files must conform to GitHub Flavored Markdown. Markdown must be formatted with: