mirror of
https://github.com/status-im/nimbus-eth2.git
synced 2025-01-11 23:04:26 +00:00
6973c38de2
* use same versions as style guide * remove obsoletion notice from summary - this is not supported by mdbook: https://github.com/rust-lang/mdBook/issues/1766
28 lines
830 B
Markdown
28 lines
830 B
Markdown
# Documentation
|
|
|
|
## material for mkdocs
|
|
|
|
The Nimbus guide is generated using [Material for mkdocs](https://squidfunk.github.io/mkdocs-material/), and installed using a python VENV (see Makefile).
|
|
|
|
## mdbook
|
|
|
|
Some books in this folder were produced using [mdBook](https://github.com/rust-lang/mdBook) - see installation guide.
|
|
|
|
```bash
|
|
# Install or update tooling (make sure you add "~/.cargo/bin" to PATH):
|
|
cargo install mdbook --version 0.4.36
|
|
cargo install mdbook-toc --version 0.14.1
|
|
cargo install mdbook-open-on-gh --version 2.4.1
|
|
cargo install mdbook-admonish --version 1.14.0
|
|
|
|
# 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
|
|
```
|