Skip to content
Snippets Groups Projects
Verified Commit cb5cc853 authored by David Runge's avatar David Runge :chipmunk:
Browse files

feat: Render top-level docs using mdbook

Rely on mdbook to render top-level documentation in a concise manner.
Using the `build-book` just recipe the mdbook (including adhoc addition
of js requirements for nermaid graphs) is built from a preselected list
of documentation files.
Afterwards all Rust documentation is collected in a `rustdoc`
subdirectory of the shared documentation output directory.

The `watch-book` and `serve-book` just recipes enable a worklow in which
relevant files are watched and the output dir is continuously served
using an adhoc webserver.

Fixes: #124


Signed-off-by: default avatarDavid Runge <dvzrv@archlinux.org>
parent 2a7f446e
No related branches found
No related tags found
Loading
Showing
with 103 additions and 2 deletions
Loading
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment