Skip to content

Update renderers.md to included preferences for the markdown renderer #2743

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update renderers.md to included preferences for the markdown renderer #2743

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions guide/src/format/configuration/renderers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The following backends are built-in:
* [`html`](#html-renderer-options) --- This renders the book to HTML.
This is enabled by default if no other `[output]` tables are defined in `book.toml`.
* [`markdown`](#markdown-renderer) --- This outputs the book as markdown after running the preprocessors.
This is useful for debugging preprocessors.
This is useful for debugging preprocessors and producing AI friendly content.

The community has developed several backends.
See the [Third Party Plugins] wiki page for a list of available backends.
Expand Down Expand Up @@ -321,9 +321,11 @@ Note that the source location does not support `#` anchor redirects.
## Markdown Renderer

The Markdown renderer will run preprocessors and then output the resulting
Markdown. This is mostly useful for debugging preprocessors, especially in
conjunction with `mdbook test` to see the Markdown that `mdbook` is passing
to `rustdoc`.
Markdown. This is useful:

- for debugging preprocessors, especially in conjunction with `mdbook test`
to see the Markdown that `mdbook` is passing to `rustdoc`.
- when producing content for audiences that prefer markdown (like AI).

The Markdown renderer is included with `mdbook` but disabled by default.
Enable it by adding an empty table to your `book.toml` as follows:
Expand Down