Create an online book with Jupyter Notebooks and Jekyll
Clone or download
Latest commit 6ce1c43 Jan 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci ignoring gh-pages for circle Jan 11, 2019
_bibliography adding citations builder Dec 19, 2018
_build improving section numbering and adding front page redirecting behavior Jan 18, 2019
_data adding search functionality and external links in sidebar Jan 18, 2019
_includes adding anchors, fixing interact link generation, fixing index redirec… Jan 19, 2019
_layouts adding search functionality and external links in sidebar Jan 18, 2019
_sass improving right sidebar css Jan 18, 2019
assets adding anchors, fixing interact link generation, fixing index redirec… Jan 19, 2019
content Fix very small typo Jan 20, 2019
scripts adding anchors, fixing interact link generation, fixing index redirec… Jan 19, 2019
.gitignore updating circle build to use raw HTML an deploy to jupyter-book.githu… Jan 4, 2019
CHANGELOG.md transferring over book to new owner Jan 11, 2019
Gemfile adding citations builder Dec 19, 2018
Gemfile.lock updating circle build to use raw HTML an deploy to jupyter-book.githu… Jan 4, 2019
Guardfile adding new build system Oct 23, 2018
LICENSE adding new build system Oct 23, 2018
Makefile updating circle build to use raw HTML an deploy to jupyter-book.githu… Jan 4, 2019
README.md transferring over book to new owner Jan 11, 2019
_config.yml improving section numbering and adding front page redirecting behavior Jan 18, 2019
build-environment.yml updating install instructions to use conda Nov 30, 2018
build-requirements.txt updating install instructions to use conda Nov 30, 2018
requirements.txt updating requirements for binder Dec 29, 2018

README.md

Jupyter Book

CircleCI

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? Don't hesitate to open an issue or a PR on the Jupyter Book template repo. We'd love your help!

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.