Repository files navigation

developer Documentation

An open source developers documentation book forrustic that you can readhere.

This book is built withmdbook. You caninstall it by runningcargo install mdbook.

• cargo install mdbook-last-changed for date changes in the footer

• cargo install mdbook-pandoc for rendering the book to PDF

# Source the .env file to get the PANDOC_VERSION. ./.envsudo apt-get updatesudo apt-get install -y texlive texlive-latex-extra texlive-luatex texlive-lang-cjk librsvg2-bin fonts-notocurl -LsSf https://github.com/jgm/pandoc/releases/download/$PANDOC_VERSION/pandoc-$PANDOC_VERSION-linux-amd64.tar.gz| tar zxf -

If you want to build it locally you can run one of these two commands in theroot directory of the repository:

• mdbook build

  Builds static html pages as output and places them in the/book directory bydefault.

• mdbook serve

  Serves the book athttp://localhost:3000 (port is changeable, take a look atthe terminal output to be sure) and reloads the browser when a change occurs.

The content of this repository is licensed underMPL-2.0; seeLICENSE.