Books with Jupyter

    Jupyter Books lets you build an online book using a collection of Jupyter Notebooksand 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 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
    • The website itself is based on Jekyll and is highly extensible.
    • There are lots of nifty HTML features under-the-hood, such asTurbolinks 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 lookslike this:

    ✨experimental✨

    This documentation is for the , whichmeans that it might be slightly out-of-date with thelatest version released on pip.

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

    • is a quick demo and overviewof Jupyter Books.

    • The Jupyter Book Guidewill step you through the process of configuring and building your own Jupyter Book.

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

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

    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:

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

    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 with support of the UC Berkeley Data Science Education Program and theBerkeley Institute for Data Science.