jesus/mdbook
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
No description
2503 commits 2 branches 0 tags 9.1 MiB
Find a file
Eric Huss b20b1757a9 Add footnote backreferences, and update styling 
This makes several changes to how footnotes are rendered:

- Backlinks are now included, which links back to the reference so you
  can continue reading where you left off.
- Footnotes are moved to the bottom of the page. This helps with the
  implementation of numbering, and is a style some have requested. I
  waffled a lot on this change, but supporting the in-place style was
  just adding too much complexity.
- Footnotes are now highlighted when you click on a reference.
- Some of the spacing for elements within a footnote has now been fixed
  (such as supporting multiple paragraphs).
- Footnote navigation now scrolls to the middle of the page.

This is an alternative to https://github.com/rust-lang/mdBook/pull/2475

Closes https://github.com/rust-lang/mdBook/issues/1927
Closes https://github.com/rust-lang/mdBook/issues/2169
Closes https://github.com/rust-lang/mdBook/issues/2595
2025-03-30 06:44:59 -07:00
.github Merge pull request #2554 from GuillaumeGomez/eslint 2025-03-23 19:50:44 +00:00
ci Test more targets. 2024-05-16 17:27:28 -07:00
examples Add a real example of remove-emphasis 2024-11-02 15:41:55 -07:00
guide Update to 0.4.47 2025-03-09 09:14:57 -07:00
src Add footnote backreferences, and update styling 2025-03-30 06:44:59 -07:00
test_book Fix, and test, the no-js toc sidebar with hashed resources 2025-02-20 10:27:18 -07:00
tests Add footnote backreferences, and update styling 2025-03-30 06:44:59 -07:00
.eslintrc.json Fix eslint warnings 2025-03-23 10:06:12 +01:00
.gitattributes Explicitly mark fonts and images files as binary (#951) 2019-06-11 21:44:15 +02:00
.gitignore Add base for GUI tests 2024-12-16 17:45:36 +01:00
Cargo.lock Update to 0.4.47 2025-03-09 09:14:57 -07:00
Cargo.toml Update to 0.4.47 2025-03-09 09:14:57 -07:00
CHANGELOG.md Update to 0.4.47 2025-03-09 09:14:57 -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 Fix eslint warnings 2025-03-23 10:06:12 +01: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

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.