Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 1.86 KB

Readme.md

File metadata and controls

60 lines (40 loc) · 1.86 KB
Raw

developer Documentation

An open source developers documentation book for rustic that you can read here.

Installation

This book is built with mdbook. You can install it by running cargo install mdbook.

Additional dependencies

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

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

Texlive

# Source the .env file to get the PANDOC_VERSION
. ./.env

sudo apt-get update

sudo apt-get install -y texlive texlive-latex-extra texlive-luatex texlive-lang-cjk librsvg2-bin fonts-noto

curl -LsSf https://github.com/jgm/pandoc/releases/download/$PANDOC_VERSION/pandoc-$PANDOC_VERSION-linux-amd64.tar.gz | tar zxf -

Building with mdbook

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

  • mdbook build

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

  • mdbook serve

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

License

The content of this repository is licensed under MPL-2.0; see LICENSE.