Skip to content

Commit 2b07207

Browse files
authored
Merge pull request #4032 from rust-lang/updated-build-instructions
Update build instructions: include mdbook plugins
2 parents e2b7246 + d5932d2 commit 2b07207

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,16 @@ rust-lang/rust uses in [this file][rust-mdbook]. To get it:
3333
$ cargo install mdbook --locked --version <version_num>
3434
```
3535

36+
The book also uses two mdbook plugins which are part of this repository. If you
37+
do not install them, you will see warnings when building and the output will not
38+
look right, but you *will* still be able to build the book. To use the plugins,
39+
you should run:
40+
41+
```bash
42+
$ cargo install --locked --path packages/mdbook-trpl-listing
43+
$ cargo install --locked --path packages/mdbook-trpl-note
44+
```
45+
3646
## Building
3747

3848
To build the book, type:

0 commit comments

Comments
 (0)