skoupidi 5607d2adac doc/Makefile: updated with new darkfid rpc files naming scheme пре 7 месеци
..
src ee68360232 doc: Fix mdbook build with latest mdbook version пре 7 месеци
theme bf419a6b55 doc: add support for colorizing zkas code samples in darkfi book пре 1 година
.gitignore 0eb4049575 doc: use a venv for python deps пре 1 година
Makefile 5607d2adac doc/Makefile: updated with new darkfid rpc files naming scheme пре 7 месеци
README.md dfe77e9c62 doc: mention mdbook in installation instructions пре 1 година
book.toml ee68360232 doc: Fix mdbook build with latest mdbook version пре 7 месеци
build_jsonrpc.py 1d28313dfd doc: Improve JSONRPC doc generation пре 7 месеци
generate_seminar_ics.py ae3c67a7e0 replace ircd with darkirc throughout the codebase пре 2 година
ghp_push.py 310a28f53a book: Always overwrite history to reduce repo size. пре 3 година
latex-macros.txt ee68360232 doc: Fix mdbook build with latest mdbook version пре 7 месеци
remove_chapter_nav_js.py 68d76dece7 doc: glob chapter nav removal since mdbook now appends a ref пре 7 месеци
requirements.txt 0eb4049575 doc: use a venv for python deps пре 1 година

README.md

The DarkFi book

This directory contains the sources for the book that can be read on https://darkrenaissance.github.io/darkfi

When adding or removing a section of the book, make sure to update the SUMMARY.md file to actually list the contents.

Use a python virtual environment to install its requirements:

% python -m venv venv
% source venv/bin/activate

Then install the requirements:

% pip install -r requirements.txt

Using the Makefile to build the sources requires the Rust mdbook utility which may be installed via:

cargo install mdbook

For the mdbook-katex backend run:

cargo install --git "https://github.com/lzanini/mdbook-katex"
cargo install --git "https://github.com/badboy/mdbook-toc"
cargo install --git "https://github.com/badboy/mdbook-mermaid"