nimbus-eth2/docs
tersec 6b8061b5d6
automated consensus spec URL updating to v1.5.0-alpha.2 (#6279)
2024-05-09 05:03:10 +00:00
..
nbc_audit_2020
the_auditors_handbook rename reference of `RangeError` to `RangeDefect` (#5902) 2024-02-17 20:29:06 +01:00
the_nimbus_book automated consensus spec URL updating to v1.5.0-alpha.2 (#6279) 2024-05-09 05:03:10 +00:00
.gitignore Migrate docs to mkdocs (#3900) 2022-07-22 21:47:24 +02:00
Makefile Version 23.3.0 2023-03-11 02:51:44 +02:00
README.md update mdbook versions 2023-11-10 08:40:04 +01:00
attestation_flow.dot
attestation_flow.md some consensus spec v1.4.0 spec URL updates (#6208) 2024-04-17 05:51:16 +02:00
attestation_flow.png
block_flow.dot
block_flow.md some consensus spec v1.4.0 spec URL updates (#6208) 2024-04-17 05:51:16 +02:00
block_flow.png
cpu_features.md docs: fix typos (#5689) 2024-01-03 12:48:08 +00:00
e2store.md chore: remove repetitive words (#6219) 2024-04-19 11:31:15 +00:00
logging.md
requirements.in Migrate docs to mkdocs (#3900) 2022-07-22 21:47:24 +02:00
requirements.txt Bump jinja2 from 3.1.3 to 3.1.4 in /docs (#6269) 2024-05-06 22:35:57 +00:00

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