-
- Downloads
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:David Runge <dvzrv@archlinux.org>
parent
2a7f446e
No related branches found
No related tags found
Showing
- .codespellrc 1 addition, 1 deletion.codespellrc
- .env 1 addition, 1 deletion.env
- .gitignore 2 additions, 0 deletions.gitignore
- justfile 38 additions, 0 deletionsjustfile
- resources/docs/book.toml 22 additions, 0 deletionsresources/docs/book.toml
- resources/docs/src/CONTRIBUTING.md 1 addition, 0 deletionsresources/docs/src/CONTRIBUTING.md
- resources/docs/src/README.md 1 addition, 0 deletionsresources/docs/src/README.md
- resources/docs/src/SUMMARY.md 27 additions, 0 deletionsresources/docs/src/SUMMARY.md
- resources/docs/src/architecture/design.md 1 addition, 0 deletionsresources/docs/src/architecture/design.md
- resources/docs/src/architecture/evaluated-setups.md 1 addition, 0 deletionsresources/docs/src/architecture/evaluated-setups.md
- resources/docs/src/architecture/previous-setup.md 1 addition, 0 deletionsresources/docs/src/architecture/previous-setup.md
- resources/docs/src/nethsm-backup/README.md 1 addition, 0 deletionsresources/docs/src/nethsm-backup/README.md
- resources/docs/src/nethsm-cli/CHANGELOG.md 1 addition, 0 deletionsresources/docs/src/nethsm-cli/CHANGELOG.md
- resources/docs/src/nethsm-cli/README.md 1 addition, 0 deletionsresources/docs/src/nethsm-cli/README.md
- resources/docs/src/nethsm-config/CHANGELOG.md 1 addition, 0 deletionsresources/docs/src/nethsm-config/CHANGELOG.md
- resources/docs/src/nethsm-config/README.md 1 addition, 0 deletionsresources/docs/src/nethsm-config/README.md
- resources/docs/src/nethsm-tests/CHANGELOG.md 1 addition, 0 deletionsresources/docs/src/nethsm-tests/CHANGELOG.md
- resources/docs/src/nethsm-tests/README.md 1 addition, 0 deletionsresources/docs/src/nethsm-tests/README.md
- resources/docs/src/nethsm/CHANGELOG.md 1 addition, 0 deletionsresources/docs/src/nethsm/CHANGELOG.md
- resources/docs/src/nethsm/README.md 1 addition, 0 deletionsresources/docs/src/nethsm/README.md
Loading
Please register or sign in to comment