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).
We know this can be confusing! Jupyter Book pre-dates the MyST Document Engine and we’re still working out the best way to maintain both of them as parallel efforts.
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]
The Get Started guide covers basic steps to learn the basics of using Jupyter Book.
The Tutorials cover key workflows and concepts in more depth.
The Tutorials cover key workflows and concepts in more depth.
The MyST Guide is the reference for the full-suite of features provided by the MyST Document Engine that powers Jupyter Book.
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.