Skip to main content

Jupyter Book: Create an online book with Jupyter Notebooks and Jekyll

Project description

Jupyter Book

CircleCI codecov DOI

This is a guide and template for hosting your own book using Jupyter Notebooks and Jekyll.

Here are some highlights:

  • All course content is written in markdown and Jupyter Notebooks, stored in notebooks/
  • This site comes packaged with helper scripts to convert these into Jekyll pages (in scripts/)
  • Pages can have Binder or JupyterHub links automatically added for interactivity.
  • The website itself is based on Jekyll, and is highly extensible and can be freely-hosted on GitHub.

This repository comes with some sample textbook files from the Data 8 course for Data Science at UC Berkeley. You can update these materials and all site content with your own, and have a Jupyter-based textbook ready to go shortly!

Here are a few links of interest:

Explore this book

This website is an example of a Jupyter Book. You can explore the chapters of the book by clicking on links in the sidebar to the left. Or, you can move linearly forward and backwards by clicking the left/right arrow on your computer.

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!

We ask that all contributions to Jupyter Book respect the Jupyter code of conduct.

Acknowledgements

Jupyter Books was originally created by Sam Lau and Chris Holdgraf with support of the UC Berkeley Data Science Education Program and the Berkeley Institute for Data Science.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyter-book-0.6.4.tar.gz (2.1 MB view details)

Uploaded Source

Built Distribution

jupyter_book-0.6.4-py3-none-any.whl (3.0 MB view details)

Uploaded Python 3

File details

Details for the file jupyter-book-0.6.4.tar.gz.

File metadata

  • Download URL: jupyter-book-0.6.4.tar.gz
  • Upload date:
  • Size: 2.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0.post20191029 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3

File hashes

Hashes for jupyter-book-0.6.4.tar.gz
Algorithm Hash digest
SHA256 23b585be71e4b8ba8fd210e0a6c28d560cc6ecc040b895f2c2ecf5c2089a53ce
MD5 d21ec117a23085ee356f32e4b08a1c45
BLAKE2b-256 aab45f31b01abd1b0289a37955f285e156cf58f71ba37ccc7135330da4e91452

See more details on using hashes here.

File details

Details for the file jupyter_book-0.6.4-py3-none-any.whl.

File metadata

  • Download URL: jupyter_book-0.6.4-py3-none-any.whl
  • Upload date:
  • Size: 3.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0.post20191029 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3

File hashes

Hashes for jupyter_book-0.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e9381424882dad7cf95efaee4b57febd428e85908a77b43688fe7ed582dd7845
MD5 af334043d29ccfd3fefc4703d42b9dee
BLAKE2b-256 575fb401d8b22662f6144cd89ec8f7ac1b7bd4a3b39d6d4acad7ec1d2ce3314c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page