mirror of https://github.com/rust-lang/mdBook.git
33
Third party plugins
David Drysdale edited this page 2024-03-30 10:06:12 +00:00
Table of Contents
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-blocks
: Add beautiful Bootstrap components to your books, also supports a live viewer for vscode to write and preview your books contents in real-time!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 formdBook-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 Graphvizmdbook-tera
: A Tera preprocessor that allows template-based renderingmdbook-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. obsidianmdbook-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.mdbook-webinclude
: A preprocessor that includes content over HTTPmdbook-numeq
: A preprocessor to automatically number centered equations and later create a link to these equations for a "LaTeX" type experience.mdbook-numthm
: A preprocessor to automatically number theorems, lemmas, etc.mdbook-mathpunc
: A preprocessor that prevents line breaks between inline math blocks and punctuation marks when using mdbook-katex.mdbook-embedify
: A preprocessor that allows you to embed apps to your book, like youtube, codepen and some other apps.mdbook-alerts
: A preprocessor that add GitHub Flavored Markdown's Alerts (similar to Obsidian's Callouts) syntax supportmdbook-repl
: A preprocessor that allows you to execute code in your markdown book without any server. Python, Typescript, Javascript etc.mdbook-image-size
: A preprocessor that supports image size syntax.mdbook-shiftinclude
: A preprocessor that allows included files to be shifted left or right.
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 torustdoc --test
)mdbook-i18n-helpers
: Extract translatable text to a Gettext.po
file.mdbook-asciidoc
: Experimental AsciiDoc generator.mdbook-pandoc
: Generate PDFs and more with Pandoc.
Other
mdBook-pagetoc
: Adds sidebar table of contents.mdbook-whichlang
: Powerful Code Blocks for mdBook