Extend with Plugins

Customize and extend Jupyter Book with plugins and custom directives.

Guides in this section¶

Tutorials¶

• Create your first plugin - Step-by-step guide to building a JavaScript plugin

• Create directives and roles - Add custom MyST syntax

How-To Guides¶

• Debug plugins - Troubleshoot plugin development

Reference¶

• Abstract Syntax Tree (AST) - Understand MyST’s document structure

• Plugin dependencies - Manage plugin requirements

Common use cases¶

• Add custom directives for domain-specific content

• Create specialized roles for inline markup

• Transform content during the build process

• Integrate with external tools and services

Plugin examples¶

For community-contributed plugin examples and inspiration, see the Jupyter Book MyST plugins repository.