diff --git a/.github/workflows/kcc20-book-pages.yaml b/.github/workflows/kcc20-book-pages.yaml index ba047af..b0a2d9d 100644 --- a/.github/workflows/kcc20-book-pages.yaml +++ b/.github/workflows/kcc20-book-pages.yaml @@ -47,6 +47,9 @@ jobs: with: tool: mdbook + - name: Install mdBook Mermaid + run: cargo install mdbook-mermaid + - name: Build book run: mdbook build docs/kcc20-book diff --git a/README.md b/README.md index 3926cc0..d12473d 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ cargo run -p cli-debugger -- \ ## Documentation -See [TUTORIAL.md](docs/TUTORIAL.md) for a full language and usage tutorial, and [DECL.md](docs/DECL.md) for the covenant declaration spec. +See [TUTORIAL.md](docs/TUTORIAL.md) for a full language and usage tutorial, [DECL.md](docs/DECL.md) for the covenant declaration spec, and the [KCC20 book](https://kaspanet.github.io/silverscript/kcc20-book/). ## Credits diff --git a/docs/kcc20-book/README.md b/docs/kcc20-book/README.md index fbc451b..429d6b2 100644 --- a/docs/kcc20-book/README.md +++ b/docs/kcc20-book/README.md @@ -10,6 +10,12 @@ From the repository root: mdbook build docs/kcc20-book ``` +The book uses Mermaid diagrams, so local builds also need `mdbook-mermaid`: + +```bash +cargo install mdbook-mermaid +``` + The rendered HTML book will be written to: ```text