Skip to content

Latest commit

 

History

History
56 lines (42 loc) · 1.95 KB

index.md

File metadata and controls

56 lines (42 loc) · 1.95 KB
Raw

Configure and customize your book

Now that you've built a book, you may wish to trigger different kinds of behavior. In Jupyter Book, most configuration is controlled with a Configuration YAML file (_config.yml). This file controls a number of options that you may use to configure your book.

This page describes the general structure of _config.yml, and how you can use it to control some basic parts of your book. The rest of the pages in this section describe more detail for specific features.

Structure of _config.yml

Here is a very simple _config.yml configuration (it is taken from {download}the demo book config file <../../jupyter_book/book_template/_config.yml>):

# Book settings
title: My sample book
author: The Jupyter Book Community
logo: 'images/logo.png'

As you can see, keys correspond to configuration options, and their values are how you control behavior of the book. In this case:

  • title: controls the title of your book. In the HTML output, it is displayed in the left sidebar.
  • author: controls the book's author. In the HTML output, it is displayed in the footer.
  • logo: controls the logo of the book, relative to the book root. In the HTML output, it is displayed above the title in the left sidebar.

There are also some configuration options that are nested. For example, to configure your book to include binder links with any section built from a Jupyter Notebook, you may use the following configuration:

# Information about where the book exists on the web
repository:
  url                       : https://github.com/yourusername/yourbookrepo

# Configure your Binder links, such as the URL of the BinderHub.
binder:
  binderhub_url             : "https://mybinder.org"

Configuration reference

For a reference example of all the possible Binder links and their default values, see the section below:

   :language: yaml