Skip to content

jupyter-book/jupyter-book

Repository files navigation

Jupyter Book

Jupyter Book Badge CircleCI codecov DOI PyPI Conda

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 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.

Governance of this project and Jupyter Book 2.x

Jupyter Book 1.x is now in a maintenance phase, where new feature requests have lower priority than bugfixes.

Jupyter Book 2.x will be built on the new MyST-MD document engine. See this blog post for more information on our plans, and this blog post about the alpha release of Jupyter Book 2.x.

Jupyter Book 2.x is currently being developed on the next branch, and documentation for Jupyter Book 2.x can be found at next.jupyterbook.org.

Contribute or improve the book

Notice some inefficient CSS? A typo in the text? Want to add a cool feature so that others can enjoy the improvements to Jupyter Books? Check out the Jupyter Book Contributor's Guide. We'd love your help!

Acknowledgements

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