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

Generating the HTML documentation

Prerequisites

  • Install mdBook;
  • Install lychee to check documentation links.

HTML Documentation

Build the HTML documentation with:

$ make docs

mdbook build docs
2023-11-05 16:19:04 [INFO] (mdbook::book): Book building has started
2023-11-05 16:19:04 [INFO] (mdbook::book): Running the html backend

The generated website is at docs/book.

Check the generated website for broken links with:

$ make lint-docs

lychee --offline --no-progress --root-dir docs/book docs/book

This only checks links between local pages. It skips links to external websites.

Live-reload server

Start mdBook’s live-reload server with:

$ make live-docs

mdbook serve docs
2023-11-05 16:19:25 [INFO] (mdbook::book): Book building has started
2023-11-05 16:19:25 [INFO] (mdbook::book): Running the html backend
2023-11-05 16:19:25 [INFO] (mdbook::cmd::serve): Serving on: http://localhost:3000
2023-11-05 16:19:25 [INFO] (mdbook::cmd::watch): Listening for changes...
2023-11-05 16:19:25 [INFO] (warp::server): Server::run; addr=[::1]:3000
2023-11-05 16:19:25 [INFO] (warp::server): listening on http://[::1]:3000
  • The generated website is at docs/book;
  • Open http://localhost:3000 in a Web browser to view the live server.

Reference