Install Jupyter Book - Jupyter Book User Guide

Never used Jupyter Book before?

Jupyter Book is a very thin wrapper around the MyST Document Engine: it shares the same CLI and configuration file (see ecosystem documentation for more details). It serves primarily to as an introduction of the existing Jupyter Book community to the MyST Document 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 ...?

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 install jupyter-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 ... pip can install packages into your home directory with
```
pip install -U jupyter-book
```

Install with pip 🐍

In a virtual environment:

pip install "jupyter-book>=2.0.0"

Install with mamba / conda 🔥

mamba install -c conda-forge \
"jupyter-book"

Install with pipx ⚙️

Never heard of pipx? See the documentation for more.

pipx install "jupyter-book"

Install with uv 🚀

Never heard of uv? See the documentation for more.

uv add "jupyter-book"

Install with pixi 🔥

Never heard of pixi? See the documentation for more.

pixi add "jupyter-book"

Install with npm 🔥

Never heard of npm? See the documentation for more.

npm install -g "jupyter-book"