Third party plugins

mdBook can be extended with external commands. See the mdBook Guide for more information about extending mdBook. The following is a list of community-developed plugins for extending mdBook. If you are an author of a plugin, feel free to add it to this list!

Preprocessors

• mdbook-katex: A preprocessor rendering LaTex equations to HTML.
• mdbook-classy: Adds support for kramdown-style CSS class annotations to paragraphs.
• mdbook-plantuml: Renders PlantUML code blocks as images in your book.
• mdbook-toc: Adds inline Table of Contents.
• mdbook-pagetoc: Adds sidebar table of contents. Rust wrapper for mdBook-pagetoc.
• mdbook-svgbob: Turns ASCII diagrams into SVG.
• mdbook-mermaid: Uses mermaid.js to create diagrams from text.
• mdbook-admonish: Adds support for Material Design admonishments, based on the mkdocs-material implementation.
• mdbook-morsels: Alternative client-side search solution.
• mdbook-graphviz: Renders graphs using Graphviz
• mdbook-tera: A Tera preprocessor that allows template-based rendering
• mdbook-template: A preprocessor that allows the re-usability of template files with dynamic arguments.
• mdbook-footnote: Adds support for auto-numbered footnotes.
• mdbook-indexing: Adds support for index generation.
• mdbook-cmdrun: A preprocessor that runs arbitrary commands and replace the stdout of these commands inside the markdown file.
• mdbook-haskell: Source code includes for Haskell.
• mdbook-i18n: Enhance multi-lang version.
• mdbook-i18n-helpers: Translation support using a Gettext-based workflow.
• mdbook-keeper: Better testing support for mdbook -- add third party crates and do testing during build.
• mdbook-yml-header: Clean up the yml-header in top of files from ie. obsidian
• mdbook-private: A preprocessor that allows for private sections to be defined and hidden or kept.
• mdbook-hide: A preprocessor for mdbook that adds support for hidden chapters.
• mdbook-yapp: A preprocessor for mdbook that simply replaces text in chapters.
• mdbook-inline-highlighting: mdBook preprocessor that enables support for inline highlighting.

Backends

• mdbook-pdf: Generate PDF, based on headless_chrome and Chrome DevTools Protocol.
• mdbook-linkcheck: Checks for broken links.
• mdbook-epub: An experimental EPUB generator.
• mdbook-man: Generates man pages.
• mdbook-test: A program to run the book's contents through rust-skeptic to verify everything compiles and runs correctly (similar to rustdoc --test)
• mdbook-i18n-helpers: Extract translatable text to a Gettext .po file.
• mdbook-asciidoc: Experimental AsciiDoc generator.

Other

• mdBook-pagetoc: Adds sidebar table of contents.