Skip to content

Commit 27731fc

Browse files
authored
Merge pull request #95 from jeffabailey/add-mdbook-mermaid
Add mdbook mermaid
2 parents fc80122 + f3eadd2 commit 27731fc

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

MDBOOK.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,16 @@ To install mdBook, run the following command:
1616
cargo install mdbook
1717
```
1818

19+
Install required preprocessors:
20+
21+
```sh
22+
# Install mdbook-mermaid for Mermaid diagram support
23+
cargo install mdbook-mermaid
24+
25+
# Install mdbook-embedify for embedding external content
26+
cargo install mdbook-embedify
27+
```
28+
1929
## Usage
2030

2131
To build the book, run the following command:
@@ -41,6 +51,4 @@ We've enabled the following features:
4151

4252
## Deployment
4353

44-
TBD
45-
46-
See: <https://github.com/rust-lang/mdBook/blob/master/.github/workflows/deploy.yml>
54+
Deployment is handled by GitHub Actions. See: <https://github.com/rust-lang/mdBook/blob/master/.github/workflows/deploy.yml>

0 commit comments

Comments
 (0)