No description
Find a file
Travis Cross 44d9f4e95b Use / (or s) to open search box
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.
2025-05-13 21:48:54 +00:00
.github Update dependencies 2025-05-05 13:44:40 -07:00
ci Test more targets. 2024-05-16 17:27:28 -07:00
examples Revert: Remove the book.multilingual field 2025-05-05 14:01:49 -07:00
guide Use / (or s) to open search box 2025-05-13 21:48:54 +00:00
src Use / (or s) to open search box 2025-05-13 21:48:54 +00:00
test_book Fix, and test, the no-js toc sidebar with hashed resources 2025-02-20 10:27:18 -07:00
tests Skip serializing of the multilingual field 2025-05-05 14:05:00 -07:00
.eslintrc.json Fix eslint errors 2025-03-31 11:50:13 -07:00
.gitattributes Mark more font files as binary 2025-04-05 20:41:36 -04:00
.gitignore Add testsuite book directories to ignore list 2025-04-22 21:11:54 -07:00
Cargo.lock Update to 0.4.49 2025-05-05 14:44:37 -07:00
Cargo.toml Update to 0.4.49 2025-05-05 14:44:37 -07:00
CHANGELOG.md Update to 0.4.49 2025-05-05 14:44:37 -07:00
CODE_OF_CONDUCT.md add explicit code of conduct, copying other rust-lang repos 2021-07-26 11:52:24 -07:00
CONTRIBUTING.md Add information on eslint and how to install and run it 2025-03-23 10:06:12 +01:00
LICENSE Create LICENSE 2015-07-29 01:11:30 +02:00
package.json Move JS files into front-end/js 2025-03-31 21:18:22 +02:00
README.md README.md: update workflow status badge 2025-02-13 11:01:08 -05:00
release.toml Metadata for cargo-release should be in release.toml (#722) 2018-07-09 18:36:55 +08:00
triagebot.toml Add more triagebot features 2025-03-23 13:04:10 -07:00

mdBook

CI Status crates.io LICENSE

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.