mirror of
https://github.com/tlsnotary/docs-mdbook.git
synced 2026-01-07 20:03:53 -05:00
85f5ffb972
* Add Swagger UI for API Endpoints * Update html title Co-authored-by: Christopher Chong <t.kleinchong@gmail.com> * Rename swagger.html to notary_server_api.html * Update link reference * Update API endpoint description Co-authored-by: Christopher Chong <t.kleinchong@gmail.com> * Update swagger style to support darkmode Co-authored-by: Hendrik Eeckhaut <hendrik@eeckhaut.org> * Revert swagger style to light mode --------- Co-authored-by: Christopher Chong <t.kleinchong@gmail.com> Co-authored-by: Hendrik Eeckhaut <hendrik@eeckhaut.org>
TLSNotary mdBook Documentation
Build
Install mdbook and mdbook-katex
cargo install mdbook --version 0.4.37
cargo install mdbook-katex --version 0.7.0
cargo install mdbook-linkcheck
Then build and serve
mdbook serve
Diagrams
All diagrams are made with draw.io. The diagram source files are stored in the diagrams folder.
The diagram sources can be converted to png with the convert_all.sh script in the diagrams folder.