mirrors/mdBook
1
0
Fork 0
mirror of https://github.com/rust-lang/mdBook.git synced 2025-12-27 09:05:40 -05:00
Code Issues Packages Projects Releases Wiki Activity
2,896 Commits 12 Branches 110 Tags
2474ae799bae7d052a82c2fc95fd98cea0b7fb3b
Go to file
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE
Eric Huss 2474ae799b Add ToUrlPath helper trait 
This adds the `ToUrlPath` helper trait to convert a Path to a path
suitable for use in HTML (replacing `normalize_path`).

This also fixes a minor bug where on Windows the next/prev links were
using a double forward slash. I don't think this is possible, since
chapter links are derived from the summary, but I'm noting just in case.
It's also not too much of an issue since double slashes are normally
just treated as a single.
2025-09-15 07:44:10 -07:00
.github
Support publishing a pre-release version of the guide
2025-09-04 17:08:49 -07:00
ci
Support publishing a pre-release version of the guide
2025-09-04 17:08:49 -07:00
crates
Add ToUrlPath helper trait
2025-09-15 07:44:10 -07:00
examples
Rename Book.sections to Book.items
2025-08-22 18:51:04 -07:00
guide
Switch from log to tracing
2025-09-12 06:13:45 -07:00
src
Remove clap macro_use
2025-09-12 06:49:54 -07:00
test_book
Add sidebar heading navigation
2025-08-27 14:44:12 -07:00
tests
Switch from log to tracing
2025-09-12 06:13:45 -07:00
.git-blame-ignore-revs
Add .git-blame-ignore-revs
2025-07-23 17:29:53 -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
Remove chrono
2025-09-15 06:50:50 -07:00
Cargo.toml
Remove chrono
2025-09-15 06:50:50 -07:00
CHANGELOG.md
Update to 0.4.52
2025-07-14 15:45:55 -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
Use consistent sentence case for section headers
2025-08-16 14:59:05 -07:00
eslint.config.mjs
Lint HBS JS templates
2025-08-25 15:15:47 -07:00
LICENSE
Create LICENSE
2015-07-29 01:11:30 +02:00
package.json
Update browser-ui-test version to 0.22.1
2025-09-08 17:25:08 +02:00
README.md
README.md: update workflow status badge
2025-02-13 11:01:08 -05:00
rustfmt.toml
Add rustfmt.toml
2025-07-23 17:29:55 -07:00
triagebot.toml
Add more triagebot features
2025-03-23 13:04:10 -07:00

README.md

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.

Description
Create book from markdown files. Like Gitbook but implemented in Rust
Readme MPL-2.0 20 MiB
Languages
Rust 75.7%
JavaScript 7.6%
CSS 6.5%
Handlebars 5.5%
HTML 4%
Other 0.7%