bf5611cf7c | ||
---|---|---|
.. | ||
nbc_audit_2020 | ||
the_auditors_handbook | ||
the_nimbus_book | ||
.gitignore | ||
Makefile | ||
README.md | ||
attestation_flow.dot | ||
attestation_flow.md | ||
attestation_flow.png | ||
block_flow.dot | ||
block_flow.md | ||
block_flow.png | ||
cpu_features.md | ||
e2store.md | ||
logging.md | ||
requirements.in | ||
requirements.txt |
README.md
Documentation
material for mkdocs
The Nimbus guide is generated using Material for mkdocs, and installed using a python VENV (see Makefile).
mdbook
Some books in this folder were produced using mdBook - see installation guide.
# Install or update tooling (make sure you add "~/.cargo/bin" to PATH):
cargo install mdbook --version 0.4.35
cargo install mdbook-toc --version 0.14.1
cargo install mdbook-open-on-gh --version 2.4.1
cargo install mdbook-admonish --version 1.13.1
# Work on the book locally - open "http://localhost:4000" for live version
cd docs/the_auditors_handbook
mdbook serve -p 4000
# Create a local copy of the book
make book
# Publish book using makefile (in the top-level dir)
make publish-book