Jupyter Book is a distribution of the MyST Document Engine.
See mystmd.org for more complete documentation¶
Because Jupyter Book is a distribution of the MyST Document Engine, we keep most documentation about configuring and using Jupyter Book in the MyST User Guide. Anything you can do with MyST you can do with Jupyter Book - the only difference in using the two is the CLI verb (jupyter book vs. myst).
Navigate the Jupyter Book documentation¶
This User Guide steps you through high-level concepts, tutorials for step-by-step learning, and how-to guides to get things done. It focuses on use-cases for multi-document projects, like community knowledge bases and multi-page books.[1]
Install Jupyter Book and create your first project.
Step-by-step tutorial to build and publish a website.
Learn to write with MyST Markdown, add figures, citations, and math.
Export to PDF, publish to GitHub Pages, and deploy your book.
Browse documentation by type¶
Looking for something specific? Browse by documentation type:
Tutorials - Step-by-step learning paths:
Build a website - Create and publish your first site
Execute code - Run computational notebooks
Create plugins - Extend Jupyter Book with custom directives
How-To Guides - Solve specific problems:
Create content - Add pages and structure
Cross-reference - Link between sections
Add math equations - Write LaTeX mathematics
Export to PDF - Generate PDF documents
Reference - Technical specifications:
MyST Guide - Complete MyST reference
Table of contents - TOC structure
Community - Get help and contribute:
Get help - Discord, discussions, bug reports
FAQ - Frequently asked questions
Contributing - How to contribute
The Jupyter Book and MyST documentation follow the Diataxis documentation framework. Within that framework, we aim for jupyterbook.org to contain tutorials and how-to guides, and the MyST guide to focus on reference documentation and deeper explanation.