Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Building the documentation

The documenation for codetracer is written in Markdown using mdbook. We use some extensions from GitHub Flavoured Markdown : specifically alert boxes with mdbook-alerts.

To build the documentation run just build-docs. If you want to iterate on the documentation for local development, run just serve-docs [<hostname>] [<port>] or by going in the docs directory and running mdbook serve [--hostname <hostname>] [--port <port>] and a web server will be started, by default on http://localhost:3000 .

The built doc files are stored under docs/experimental-documentation/build, while the markdown files are under docs/experimental-documentation and its child directories.