nimbus-eth2/docs
dependabot[bot] a18bd40208
Bump pygments from 2.12.0 to 2.15.0 in /docs (#5206)
Bumps [pygments](https://github.com/pygments/pygments) from 2.12.0 to 2.15.0.
- [Release notes](https://github.com/pygments/pygments/releases)
- [Changelog](https://github.com/pygments/pygments/blob/master/CHANGES)
- [Commits](https://github.com/pygments/pygments/compare/2.12.0...2.15.0)

---
updated-dependencies:
- dependency-name: pygments
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-07-20 14:25:45 +00:00
..
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
eth2-finalization.png
logging.md
requirements.in
requirements.txt Bump pygments from 2.12.0 to 2.15.0 in /docs (#5206) 2023-07-20 14:25:45 +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.28
cargo install mdbook-toc --version 0.8.0
cargo install mdbook-open-on-gh --version 2.3.3
cargo install mdbook-admonish --version 1.7.0

# Work on the book locally - open "http://localhost:4000" for live version
cd docs/the_nimbus_book
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