mdbook/guide/src/format
Eric Huss 873e4fe40f Add support for admonitions
This enables the admonitions support from pulldown-cmark. This includes
a config option in case it causes problems with existing books.

I would like to make this extensible in the future, though I'm not sure
what that would look like. There's also some concerns with how this will
affect translations like mdbook-i18n-helpers, which we may need to work
out in a different way.

Closes https://github.com/rust-lang/mdBook/issues/2771
2025-09-18 19:54:20 -07:00
..
configuration Add support for admonitions 2025-09-18 19:54:20 -07:00
images add the markdown page 2021-12-17 19:08:58 -08:00
theme Use consistent sentence case for section headers 2025-08-16 14:59:05 -07:00
example.rs Update examples with hidden lines (#1476) 2021-02-27 02:40:14 +01:00
markdown.md Add support for admonitions 2025-09-18 19:54:20 -07:00
mathjax.md Use consistent sentence case for section headers 2025-08-16 14:59:05 -07:00
mdbook.md Add support for admonitions 2025-09-18 19:54:20 -07:00
README.md Rename book-example to guide (#1336) 2020-09-23 03:16:09 +02:00
summary.md summary.md: clarify that part titles must be h1 headers 2024-01-31 01:47:05 -06:00

Format

In this section you will learn how to:

  • Structure your book correctly
  • Format your SUMMARY.md file
  • Configure your book using book.toml
  • Customize your theme