Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/kcc20-book-pages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 6 additions & 0 deletions docs/kcc20-book/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down