Dependencies
rustc,cargo- see rustupcargo install mdbook- mdBook builder CLIcargo install mdbook-alerts- preprocessor to add GitHub Flavored Markdown's Alerts
python3- to run thepreprocessor.pyon build
Get this builder
git clone https://github.com/twisterarmy/book.git && cd bookchmod +x build.sh
Get latest book sources
important
Current build.sh implementation operates rm command to clean up the relative paths,
ensure you are still in this project directory to continue!
./build.sh
Launch
Compiled HTML version should be available in the /book directory.
To read in the browser using a local server, run:
mdbook serve --open
note
The serve option generates additional content for local reading; do not use its output for /book contributions!