alex-treebeard / jupyter-book

Build interactive, publication-quality documents from Jupyter Notebooks

Home Page:http://jupyterbook.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Jupyter Book

CircleCI codecov DOI PyPI

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

Jupyter Book is still developing relatively rapidly, so please be patient if things change or features iterate and change quickly. Once Jupyter Book hits 1.0, it will slow down considerably!

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.

About

Build interactive, publication-quality documents from Jupyter Notebooks

http://jupyterbook.org

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:Python 80.8%Language:Jupyter Notebook 7.3%Language:HTML 7.2%Language:TeX 4.2%Language:Shell 0.6%