1. Overview#
This is a short overview of the major steps in building a Jupyter Book. See the other pages in this guide for more in-depth information.
1.1. The book building process#
Building a Jupyter Book broadly consists of these steps:
Create your book’s content. You structure your book with a collection of folders, files, and configuration. See Create your book.
Build your book. Using Jupyter Book’s command-line interface you can convert your pages into either an HTML or a PDF book. See Build your book.
Publish your book online. Once your book is built, you can share it with others. Most common is to build HTML, and host it as a public website. See Publish your book online.
1.2. The Jupyter Book command-line interface#
Jupyter Book uses a command-line interface to perform a variety of actions. For example, building and cleaning books. You can run the following command to see what options are at your control:
jupyter-book --help
Now that we’ve got what you need, let’s get started building your first book.