Skip to content

Commit 6477e32

Browse files
committed
feat: add an mdBook guide
1 parent 5910bac commit 6477e32

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

MDBOOK.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# mdBook
2+
3+
Details about our mdBook setup.
4+
5+
## Installation
6+
7+
To install cargo, run the following command:
8+
9+
```bash
10+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
11+
```
12+
13+
To install mdBook, run the following command:
14+
15+
```bash
16+
cargo install mdbook
17+
```
18+
19+
## Usage
20+
21+
To build the book, run the following command:
22+
23+
```bash
24+
mdbook build
25+
```
26+
27+
To serve the book, run the following command:
28+
29+
```bash
30+
npx serve book -p 3000
31+
```
32+
33+
## Configuration
34+
35+
The configuration file is located at `book.toml`.
36+
37+
We've enabled the following features:
38+
39+
* **Giscus**: To enable comments on the book. See [mdbook-embedify](https://mr-addict.github.io/mdbook-embedify/third-party/giscus.html) for more details.
40+
* **Mermaid**: To enable diagrams in the book. See [mdbook-mermaid](https://github.com/badboy/mdbook-mermaid) for more details.
41+
42+
## Deployment
43+
44+
TBD
45+
46+
See: <https://github.com/rust-lang/mdBook/blob/master/.github/workflows/deploy.yml>

0 commit comments

Comments
 (0)