Never used Jupyter Book before?
Jupyter Book 2 is a very thin wrapper around the MyST-MD engine: it shares the same CLI and configuration file (see The Jupyter Book Toolchain for more details). It serves primarily to as an introduction of the existing Jupyter Book community to the MyST-MD engine.
If you’re new to the Jupyter Book project, consider directly using MyST-MD.
Jupyter Book is available on the PyPI, conda-forge, and npm package repositories as jupyter-book>=2. How you install Jupyter Book depends upon your choice of environment manager.
Should I use pip or ...?
pip or ...?Installing software can be confusing. Here’s a simple guide to making a sensible choice.
Are you using an Environment Manager?
If you are already using an environment manager, you should use that tool to installjupyter-book.Are you willing to use an Environment Manager?
There are lots of environment managers to choose from. If you aren’t sure which to choose, it is recommended to start with a Python virtual environment.Otherwise ...
pipcan install packages into your home directory with
pip install -U jupyter-book>=2Install with pip 🐍
In a virtual environment:
pip install "jupyter-book>=2"Install with mamba / conda 🔥
mamba install -c conda-forge \
"jupyter-book>=2"Install with pipx ⚙️
Never heard of pipx? See the documentation for more.
pipx install "jupyter-book>=2"Install with pixi 🔥
Never heard of pixi? See the documentation for more.
pixi add "jupyter-book>=2"Install with npm 🔥
Never heard of npm? See the documentation for more.
npm install -g "jupyter-book@>=2"