Advanced start 🌶

The Jupyter Book and MyST CLIs both include tools to help get started writing quickly. You might want to follow this approach if:

• You are already familiar with using Markdown dialects to build documents and websites

• You have previously used Jupyter Book 1

• You are comfortable working with command line tools and reading documentation

• You don’t like waiting for GitHub Actions to see updates to your book as you edit it

The MyST Markdown guide will be a valuable resource if you follow this route.

Install Jupyter Book¶

There are a number of options for installing Jupyter Book. Two common methods are using pip

pip install "jupyter-book>=2.0.0a0"

or npm

npm install -g "jupyter-book@>=2.0.0-a0"

Initialise a project with CLI¶

To initialise a Jupyter Book project, use the CLI

jupyter-book init

This will create a basic book, including the myst.yml file. You can serve your book locally

jupyter-book start

Open http://localhost:3000 in your browser to see the output.

Edit the content¶

You can edit the content files in the content directory using your text editor and see the output immediately updated in your browser at the local server address (you may need to refresh the page when changes are made).

You may want to follow the lessons here or experiment yourself with the MyST Markdown guide.

Deploy to GitHub pages¶

The CLI can also prepare a GitHub workflow to deploy your book to GitHub Pages, similar to the template.

jupyter-book init --gh-pages

The command will print instructions to finish setting up GitHub Pages.