Skip to content

Commit

Permalink
Merge pull request #4032 from rust-lang/updated-build-instructions
Browse files Browse the repository at this point in the history
Update build instructions: include mdbook plugins
  • Loading branch information
chriskrycho authored Sep 12, 2024
2 parents e2b7246 + d5932d2 commit 2b07207
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,16 @@ rust-lang/rust uses in [this file][rust-mdbook]. To get it:
$ cargo install mdbook --locked --version <version_num>
```

The book also uses two mdbook plugins which are part of this repository. If you
do not install them, you will see warnings when building and the output will not
look right, but you *will* still be able to build the book. To use the plugins,
you should run:

```bash
$ cargo install --locked --path packages/mdbook-trpl-listing
$ cargo install --locked --path packages/mdbook-trpl-note
```

## Building

To build the book, type:
Expand Down

0 comments on commit 2b07207

Please sign in to comment.