33This document explains how to make additions and changes to the Clippy book, the
44guide to Clippy that you're reading right now. The Clippy book is formatted with
55[ Markdown] ( https://www.markdownguide.org ) and generated by
6- [ mdbook ] ( https://github.com/rust-lang/mdBook ) .
6+ [ mdBook ] ( https://github.com/rust-lang/mdBook ) .
77
8- - [ Get mdbook ] ( #get-mdbook )
8+ - [ Get mdBook ] ( #get-mdbook )
99- [ Make changes] ( #make-changes )
1010
11- ## Get mdbook
11+ ## Get mdBook
1212
1313While not strictly necessary since the book source is simply Markdown text
14- files, having mdbook locally will allow you to build, test and serve the book
14+ files, having mdBook locally will allow you to build, test and serve the book
1515locally to view changes before you commit them to the repository. You likely
1616already have ` cargo ` installed, so the easiest option is to simply:
1717
1818``` shell
1919cargo install mdbook
2020```
2121
22- See the mdbook [ installation] ( https://github.com/rust-lang/mdBook#installation )
22+ See the mdBook [ installation] ( https://github.com/rust-lang/mdBook#installation )
2323instructions for other options.
2424
2525## Make changes
2626
2727The book's
2828[ src] ( https://github.com/rust-lang/rust-clippy/tree/master/book/src )
2929directory contains all of the markdown files used to generate the book. If you
30- want to see your changes in real time, you can use the mdbook ` serve ` command to
30+ want to see your changes in real time, you can use the mdBook ` serve ` command to
3131run a web server locally that will automatically update changes as they are
3232made. From the top level of your ` rust-clippy ` directory:
3333
@@ -38,5 +38,5 @@ mdbook serve book --open
3838Then navigate to ` http://localhost:3000 ` to see the generated book. While the
3939server is running, changes you make will automatically be updated.
4040
41- For more information, see the mdbook
41+ For more information, see the mdBook
4242[ guide] ( https://rust-lang.github.io/mdBook/ ) .
0 commit comments