mirror of
https://github.com/AtHeartEngineer/docs-mdbook.git
synced 2026-01-09 00:58:13 -05:00
22 lines
492 B
Markdown
22 lines
492 B
Markdown
# TLSNotary mdBook Documentation
|
|
|
|
## Build
|
|
|
|
Install mdbook and mdbook-katex
|
|
|
|
```bash
|
|
cargo install mdbook --version 0.4.32
|
|
cargo install mdbook-katex --version 0.5.5
|
|
cargo install mdbook-linkcheck
|
|
```
|
|
|
|
Then build and serve
|
|
|
|
```bash
|
|
mdbook serve
|
|
```
|
|
|
|
## Diagrams
|
|
|
|
All diagrams are made with [draw.io](https://app.diagrams.net/). 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. |