# <img src="https://raw.githubusercontent.com/executablebooks/jupyter-book/master/docs/images/logo-square.svg" width=40 /> Jupyter Book
[](https://jupyterbook.org)
[](https://circleci.com/gh/executablebooks/jupyter-book)
[](https://codecov.io/gh/executablebooks/jupyter-book)
[](https://doi.org/10.5281/zenodo.2561065)
[![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](https://myst-parser.readthedocs.io/en/latest/) 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](https://jupyter-cache.readthedocs.io/en/latest/) the outputs and convert this content into:
* a web-based interactive book and
* a publication-quality PDF.
## Governance of this project
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](https://mystmd.org/). See [our blog post](https://executablebooks.org/en/latest/blog/2024-05-20-jupyter-book-myst/) for more information.
## 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](https://jupyterbook.org/contribute/intro.html). We'd love your help!
## Acknowledgements
Jupyter Book is maintained and primarily developed by
the [Executable Book Project](https://executablebooks.org).
[pypi-badge]: https://img.shields.io/pypi/v/jupyter-book.svg
[pypi-link]: https://pypi.org/project/jupyter-book
[conda-badge]: https://anaconda.org/conda-forge/jupyter-book/badges/version.svg
[conda-link]: https://anaconda.org/conda-forge/jupyter-book
Raw data
{
"_id": null,
"home_page": null,
"name": "jupyter-book",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "reproducible, science, environments, scholarship, notebook",
"author": null,
"author_email": "Executable Book Project <executablebooks@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/32/ea/ec3ffc3b9a2d2100345d01b656ce4ac850a28defdf71a3aecdfaa44bbad0/jupyter_book-1.0.3.tar.gz",
"platform": null,
"description": "# <img src=\"https://raw.githubusercontent.com/executablebooks/jupyter-book/master/docs/images/logo-square.svg\" width=40 /> Jupyter Book\n\n[](https://jupyterbook.org)\n[](https://circleci.com/gh/executablebooks/jupyter-book)\n[](https://codecov.io/gh/executablebooks/jupyter-book)\n[](https://doi.org/10.5281/zenodo.2561065)\n[![PyPI][pypi-badge]][pypi-link]\n[![Conda][conda-badge]][conda-link]\n\nJupyter Book is an open-source tool for building publication-quality books and documents from computational material.\n\nJupyter Book allows users to\n\n* write their content in [markdown files](https://myst-parser.readthedocs.io/en/latest/) or [Jupyter](https://jupyter.org/) notebooks,\n* include computational elements (e.g., code cells) in either type,\n* include rich syntax such as citations, cross-references, and numbered equations, and\n* using a simple command, run the embedded code cells, [cache](https://jupyter-cache.readthedocs.io/en/latest/) the outputs and convert this content into:\n * a web-based interactive book and\n * a publication-quality PDF.\n\n## Governance of this project\nJupyter 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](https://mystmd.org/). See [our blog post](https://executablebooks.org/en/latest/blog/2024-05-20-jupyter-book-myst/) for more information.\n\n## Contribute or improve the book\n\nNotice some inefficient CSS? A typo in the text? Want to add a cool feature so that others\ncan enjoy the improvements to Jupyter Books? Check out the [Jupyter Book Contributor's\nGuide](https://jupyterbook.org/contribute/intro.html). We'd love your help!\n\n## Acknowledgements\n\nJupyter Book is maintained and primarily developed by\nthe [Executable Book Project](https://executablebooks.org).\n\n[pypi-badge]: https://img.shields.io/pypi/v/jupyter-book.svg\n[pypi-link]: https://pypi.org/project/jupyter-book\n[conda-badge]: https://anaconda.org/conda-forge/jupyter-book/badges/version.svg\n[conda-link]: https://anaconda.org/conda-forge/jupyter-book\n",
"bugtrack_url": null,
"license": null,
"summary": "Build a book with Jupyter Notebooks and Sphinx.",
"version": "1.0.3",
"project_urls": {
"Documentation": "https://jupyterbook.org",
"Funding": "https://executablebooks.org",
"Homepage": "https://executablebooks.org/",
"Source": "https://github.com/executablebooks/jupyter-book/",
"Tracker": "https://github.com/executablebooks/jupyter-book/issues"
},
"split_keywords": [
"reproducible",
" science",
" environments",
" scholarship",
" notebook"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2b3d3b0360dade8df5d5f7a30f230f1316ded7e029d7f60a6e38b3765be47603",
"md5": "65f980ba857943579be43ccc8a07da4c",
"sha256": "d99b0c92c62b469abc2b61047c1290923bce460367c6a7e296589cadc726119f"
},
"downloads": -1,
"filename": "jupyter_book-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "65f980ba857943579be43ccc8a07da4c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 44000,
"upload_time": "2024-10-07T14:05:26",
"upload_time_iso_8601": "2024-10-07T14:05:26.427316Z",
"url": "https://files.pythonhosted.org/packages/2b/3d/3b0360dade8df5d5f7a30f230f1316ded7e029d7f60a6e38b3765be47603/jupyter_book-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "32eaec3ffc3b9a2d2100345d01b656ce4ac850a28defdf71a3aecdfaa44bbad0",
"md5": "025d8fc9d6db3cec39c055325b9d6abd",
"sha256": "f05788a76f4d284de9887fa816f4a99a4f16cc5f7c0fd5a56074a3d03bfc3e50"
},
"downloads": -1,
"filename": "jupyter_book-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "025d8fc9d6db3cec39c055325b9d6abd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 66469,
"upload_time": "2024-10-07T14:05:27",
"upload_time_iso_8601": "2024-10-07T14:05:27.946907Z",
"url": "https://files.pythonhosted.org/packages/32/ea/ec3ffc3b9a2d2100345d01b656ce4ac850a28defdf71a3aecdfaa44bbad0/jupyter_book-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 14:05:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "executablebooks",
"github_project": "jupyter-book",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyter-book"
}
JSON
