No description
Find a file
Travis Cross 52e406bf95 Use <kbd> tag to describe keyboard shortcuts
When describing, in the guide, the keyboard shortcuts that we accept,
let's use the `<kbd>` element.  This causes the key to render in a box
that people will recognize as conventional.

The way that this is displayed helps to make it clear that, though we
present the key in uppercase, we actually mean for the lowercase
letter to be entered.  Therefore, we present the key in uppercase
since 1) that's how it appears on most keyboards and 2) for some
characters such as `l`, presenting the character in lowercase might be
ambiguous.

We'll spell out "Escape" rather than saying "Esc" (even though many
keyboards spell it that way) since the `KeyboardEvent.keycode`[^1] is
called "Escape", and that's how it would appear in an
`aria-keyshortcuts` attribute[^2].

[^1]: https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyCode

[^2]: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-keyshortcuts
2025-05-13 22:04:49 +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 <kbd> tag to describe keyboard shortcuts 2025-05-13 22:04:49 +00:00
src Navigate to first search result on enter 2025-05-13 21:50:04 +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.