No description
We allow for using `s` to open the search box, but it's more common to use `/` (forward slash) for this. E.g., MDN's documentation uses `/` for search. Rustdoc and GitHub accept either. Let's allow either key to be used, and let's switch to "advertising" `/` rather than `s` in the hover text for the search button. In making that switch, let's also simplify that hover text a bit. Previously it had said "Search. (Shortkey: s)". This was the only top button on which we had included a period in the hover text. Let's remove that, and let's remove the "shortkey" bit of jargon. It's enough to just put `/` in a parenthetical, i.e. "Search (`/`)". People will gleam from that what we mean. We've also updated the guide accordingly. |
||
|---|---|---|
| .github | ||
| ci | ||
| examples | ||
| guide | ||
| src | ||
| test_book | ||
| tests | ||
| .eslintrc.json | ||
| .gitattributes | ||
| .gitignore | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| release.toml | ||
| triagebot.toml | ||
mdBook
mdBook is a utility to create modern online books from Markdown files.
Check out the User Guide for a list of features and installation and usage information. The User Guide also serves as a demonstration to showcase what a book looks like.
If you are interested in contributing to the development of mdBook, check out the Contribution Guide.
License
All the code in this repository is released under the Mozilla Public License v2.0, for more information take a look at the LICENSE file.