diff options
| author | bors <bors@rust-lang.org> | 2023-01-21 13:00:20 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2023-01-21 13:00:20 +0000 |
| commit | 8d3c7f044dfd2608c3842d82f5bf10d3c4c80047 (patch) | |
| tree | 7e846a2fa7433f0228fb8a09cb4eb358b59cdb2a | |
| parent | d1a5a353a131a9d74e880c02e607c8eeb573be88 (diff) | |
| parent | 081c6178fe9e8b1a0dd311c6648263dedff35b83 (diff) | |
| download | rust-8d3c7f044dfd2608c3842d82f5bf10d3c4c80047.tar.gz rust-8d3c7f044dfd2608c3842d82f5bf10d3c4c80047.zip | |
Auto merge of #10216 - chansuke:hotfix/fix-spelling, r=llogiq
Fix spelling inconsistence of `mdBook` I was reading both [mdBook Documentation](https://rust-lang.github.io/mdBook/) and [The Clippy Book](https://doc.rust-lang.org/nightly/clippy/development/infrastructure/book.html#the-clippy-book) and felt that it's easier to read to unify the notation of `mdBook`. - \[ ] Followed [lint naming conventions][lint_naming] - \[ ] Added passing UI tests (including committed `.stderr` file) - \[x] `cargo test` passes locally - \[ ] Executed `cargo dev update_lints` - \[ ] Added lint documentation - \[x] Run `cargo dev fmt` ---- changelog: none
| -rw-r--r-- | book/src/development/infrastructure/book.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/book/src/development/infrastructure/book.md b/book/src/development/infrastructure/book.md index a4874219185..dbd624ecd73 100644 --- a/book/src/development/infrastructure/book.md +++ b/book/src/development/infrastructure/book.md @@ -3,15 +3,15 @@ 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 [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) -## Get mdbook +## Get mdBook 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 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 ``` -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. ## Make changes @@ -27,7 +27,7 @@ instructions for other options. The book's [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 -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 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 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/). |
