# <img src="https://raw.githubusercontent.com/jupyter-book/jupyter-book/next/docs/media/images/logo-square.svg" width=40 /> Jupyter Book

[![Jupyter Book Badge](https://raw.githubusercontent.com/jupyter-book/jupyter-book/next/docs/media/images/badge.svg)](https://jupyterbook.org)
[![DOI](https://img.shields.io/badge/DOI-Cite_Jupyter_Book-blue)](https://jupyterbook.org/stable/cite/)

<!-- [![PyPI][pypi-badge]][pypi-link]
     [![Conda][conda-badge]][conda-link] -->

Jupyter Book is an open-source tool for building publication-quality books and documents from computational material.

Jupyter Book allows users to

- write their content in Markdown files or [Jupyter](https://jupyter.org/) notebooks,
- include computational elements (e.g., code cells) in either type,
- include rich syntax such as citations, cross-references, and numbered equations, and
- using a simple command, run the embedded code cells, cache the outputs and convert this content into:
  - a web-based interactive book and
  - a publication-quality PDF.

> [!NOTE]
> Are you trying to access Jupyter Book v1 (the Sphinx-based documentation engine)?
> That package now resides in the [`v1` branch](https://github.com/jupyter-book/jupyter-book/tree/v1)
> of this repository.

## Governance of This Project

Jupyter Book is an official sub-project of Jupyter, you can find more about our team and governance process in our [Team Compass](https://compass.jupyterbook.org/).

## Contribute or Improve The Book

Notice a typo in the text? Want to add a cool feature so that others can enjoy the improvements to Jupyter Books?
Check out `CONTRIBUTING.md`. We'd love your help!

## Acknowledgements

Jupyter Book is maintained and primarily developed by the Jupyter Book Project.