Search
Books with Jupyter

Jupyter Books lets you build an online book using a collection of Jupyter Notebooks and Markdown files. Its output is similar to the excellent Bookdown tool, and adds extra functionality for people running a Jupyter stack.

For an example of a book built with Jupyter Books, see the textbook for Data 100 at UC Berkeley (or this website!)

Here are a few features of Jupyter Books

  • A Command-Line Interface (CLI) to quickly create, build, and upgrade books.
  • Write book content in markdown and Jupyter Notebooks
  • Convert these into Jekyll pages that can be hosted for free on GitHub
  • Pages can have Binder, JupyterHub, or Thebelab links automatically added for interactivity.
  • The website itself is based on Jekyll and is highly extensible.
  • There are lots of nifty HTML features under-the-hood, such as Turbolinks fast-navigation and click-to-copy in code cells.

Check out other features in the Features section.

Note: Throughout this guide you may see an experimental tag that looks like this:

experimental

These are features that we are playing around with, but might change in how they behave or are controlled. Please use them and give feedback, but note that they may be a bit unstable!

Getting started

This documentation is for the master branch of Jupyter Book, which means that it might be slightly out-of-date with the latest version released on pip.

To get started, you may be interested in the following links. Here are a few links of interest:

Installation

To install the Jupyter Book command-line interface (CLI), use pip!

pip install jupyter-book

alternatively, if you'd like to install the latest version from GitHub, you can run:

pip install git+https://github.com/jupyter/jupyter-book

This will install the master branch of Jupyter Book (what these docs are built from), though it might be a bit less-stable.

Create a new book

Once you've installed the CLI, create a new book using the demo book content (the website that you're viewing now) with this command:

jupyter-book create mybookname --demo

Build the markdown for your book

Now, build the markdown that Jekyll will use for your book. Run this command:

jupyter-book build mybookname

That's it!

You can now either push your book to GitHub and serve the demo with gh-pages, or modify the book with your own content.

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.