x ed32be1a60 doc: Document P2P transport mixing		vor 2 Wochen
..
src	ed32be1a60 doc: Document P2P transport mixing	vor 2 Wochen
theme	c80fd29e2e updated font and colors of code blocks in menu	vor 6 Monaten
.gitignore	0eb4049575 doc: use a venv for python deps	vor 1 Jahr
Makefile	fcf4aded0e darkfid: split managemtn rpc methods into its own rpc server and standarized all ports	vor 7 Monaten
README.md	4f30aae91d doc: Update book links	vor 7 Monaten
book.toml	3f16e941c3 book: Add darkforest theme as a default	vor 6 Monaten
build_jsonrpc.py	abad64cfdd doc: Update documentation for DarkIRC	vor 3 Wochen
generate_seminar_ics.py	abad64cfdd doc: Update documentation for DarkIRC	vor 3 Wochen
ghp_push.py	310a28f53a book: Always overwrite history to reduce repo size.	vor 3 Jahren
latex-macros.txt	ee68360232 doc: Fix mdbook build with latest mdbook version	vor 7 Monaten
remove_chapter_nav_js.py	68d76dece7 doc: glob chapter nav removal since mdbook now appends a ref	vor 7 Monaten
requirements.txt	0eb4049575 doc: use a venv for python deps	vor 1 Jahr

The DarkFi book

This directory contains the sources for the book that can be read on https://dark.fi/book/

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 plugin mdbook backends 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" mdbook-mermaid
cargo install --git "https://github.com/rustforweb/mdbook-plugins" mdbook-tabs

README.md

The DarkFi book