AtHeartEngineer/docs-mdbook

mirror of https://github.com/AtHeartEngineer/docs-mdbook.git synced 2026-01-08 00:43:49 -05:00

Go to file

Hendrik Eeckhaut fb030dd375 Merged diagrams from https://github.com/tlsnotary/docs-assets

2023-08-02 14:09:42 +02:00

.github/workflows

GitHub action: Corrected html publish dir

2023-07-25 11:39:34 +02:00

Merged diagrams from https://github.com/tlsnotary/docs-assets

2023-08-02 14:09:42 +02:00

Merged diagrams from https://github.com/tlsnotary/docs-assets

2023-08-02 14:09:42 +02:00

.gitignore

Merged diagrams from https://github.com/tlsnotary/docs-assets

2023-08-02 14:09:42 +02:00

book.toml

Build for every commit

2023-07-25 10:54:09 +02:00

README.md

Merged diagrams from https://github.com/tlsnotary/docs-assets

2023-08-02 14:09:42 +02:00

README.md

TLSNotary mdBook Documentation

Build

Install mdbook and mdbook-katex

cargo install mdbook --version 0.4.32
cargo install mdbook-katex --version 0.5.5

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.