mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix spelling inconsistence of mdBook

Browse Source
This commit is contained in:
chansuke 2023-01-20 20:25:31 +09:00
parent d1a5a353a1
commit 081c6178fe
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
book/src/development/infrastructure/book.md
View File

@ -3,15 +3,15 @@
This document explains how to make additions and changes to the Clippy book, the This document explains how to make additions and changes to the Clippy book, the
guide to Clippy that you're reading right now. The Clippy book is formatted with guide to Clippy that you're reading right now. The Clippy book is formatted with
[Markdown](https://www.markdownguide.org) and generated by [Markdown](https://www.markdownguide.org) and generated by
[mdbook](https://github.com/rust-lang/mdBook). [mdBook](https://github.com/rust-lang/mdBook).
- [Get mdbook](#get-mdbook) - [Get mdBook](#get-mdbook)
- [Make changes](#make-changes) - [Make changes](#make-changes)
## Get mdbook ## Get mdBook
While not strictly necessary since the book source is simply Markdown text While not strictly necessary since the book source is simply Markdown text
files, having mdbook locally will allow you to build, test and serve the book files, having mdBook locally will allow you to build, test and serve the book
locally to view changes before you commit them to the repository. You likely locally to view changes before you commit them to the repository. You likely
already have `cargo` installed, so the easiest option is to simply: already have `cargo` installed, so the easiest option is to simply:
@ -19,7 +19,7 @@ already have `cargo` installed, so the easiest option is to simply:
cargo install mdbook cargo install mdbook
``` ```
See the mdbook [installation](https://github.com/rust-lang/mdBook#installation) See the mdBook [installation](https://github.com/rust-lang/mdBook#installation)
instructions for other options. instructions for other options.
## Make changes ## Make changes
@ -27,7 +27,7 @@ instructions for other options.
The book's The book's
[src](https://github.com/rust-lang/rust-clippy/tree/master/book/src) [src](https://github.com/rust-lang/rust-clippy/tree/master/book/src)
directory contains all of the markdown files used to generate the book. If you directory contains all of the markdown files used to generate the book. If you
want to see your changes in real time, you can use the mdbook `serve` command to want to see your changes in real time, you can use the mdBook `serve` command to
run a web server locally that will automatically update changes as they are run a web server locally that will automatically update changes as they are
made. From the top level of your `rust-clippy` directory: made. From the top level of your `rust-clippy` directory:
@ -38,5 +38,5 @@ mdbook serve book --open
Then navigate to `http://localhost:3000` to see the generated book. While the Then navigate to `http://localhost:3000` to see the generated book. While the
server is running, changes you make will automatically be updated. server is running, changes you make will automatically be updated.
For more information, see the mdbook For more information, see the mdBook
[guide](https://rust-lang.github.io/mdBook/). [guide](https://rust-lang.github.io/mdBook/).