mirror of
https://github.com/status-im/nimbus-eth2.git
synced 2025-02-12 14:36:56 +00:00
53589b5a7d
* Add metadata for the Holesky network * Add copyright banner to the new Nim module * Working version * Bump Chronos to fix downloading from Github * Add checksum check of the downloaded file * Clean up debugging code and obsolete imports
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