Skip to content
Snippets Groups Projects

feat: Render top-level docs using mdbook

Merged David Runge requested to merge docs/mdbook into main
All threads resolved!

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 (closed) Signed-off-by: David Runge dvzrv@archlinux.org

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
Please register or sign in to reply
Loading