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.5.tar.gz (26.7 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: jupyter-book-0.6.5.tar.gz
  • Upload date:
  • Size: 26.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/42.0.1.post20191125 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.8.0

File hashes

Hashes for jupyter-book-0.6.5.tar.gz
Algorithm Hash digest
SHA256 f1511bac904df9d0f3574d87dfc0e4c6ad298bb2bc14068291ebd350426ef1af
MD5 892ee40246368d7712fd36dab4d1fa69
BLAKE2b-256 bbc18374b0d8a51ee06cdf88c20a4773430b191ebe4bf9417948352f564a3500

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jupyter_book-0.6.5-py3-none-any.whl
  • Upload date:
  • Size: 3.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/42.0.1.post20191125 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.8.0

File hashes

Hashes for jupyter_book-0.6.5-py3-none-any.whl
Algorithm Hash digest
SHA256 865e4c3b15ee900706ef65b5324c8771f37a671818b7ab81c75372ce5efd7acb
MD5 502a16927f0ac079abe337c240e74f69
BLAKE2b-256 ee3cf9c40f847a4e0f0d9037493bd038c4dfe246a4cfa54dbcdef0c8d46a8987

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