oars 7ddb347c54 doc/misc/nodes/public-guide: guide for autohosting public ipv6 and tor nodes hai 11 meses
..
src 7ddb347c54 doc/misc/nodes/public-guide: guide for autohosting public ipv6 and tor nodes hai 7 meses
theme bf419a6b55 doc: add support for colorizing zkas code samples in darkfi book hai 1 ano
.gitignore 0eb4049575 doc: use a venv for python deps hai 1 ano
Makefile 5607d2adac doc/Makefile: updated with new darkfid rpc files naming scheme hai 7 meses
README.md dfe77e9c62 doc: mention mdbook in installation instructions hai 1 ano
book.toml ee68360232 doc: Fix mdbook build with latest mdbook version hai 7 meses
build_jsonrpc.py 1d28313dfd doc: Improve JSONRPC doc generation hai 7 meses
generate_seminar_ics.py ae3c67a7e0 replace ircd with darkirc throughout the codebase %!s(int64=2) %!d(string=hai) anos
ghp_push.py 310a28f53a book: Always overwrite history to reduce repo size. %!s(int64=3) %!d(string=hai) anos
latex-macros.txt ee68360232 doc: Fix mdbook build with latest mdbook version hai 7 meses
remove_chapter_nav_js.py 68d76dece7 doc: glob chapter nav removal since mdbook now appends a ref hai 7 meses
requirements.txt 0eb4049575 doc: use a venv for python deps hai 1 ano

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"