Exercise 3: Change book configuration

Exercise 3: Change book configuration#

As we’ve added some content by now, let’s make this book a bit more personal! We’ll make some changes to the _config.yml file which changes the configuration of the book website.

Can you edit the repository url defined in the _config.yml, change the title shown below the logo and change the author as shown in the footer?

  1. Go to the the file book/_config.yml on your GitHub repository - Code - Book - _config.yml - Edit this file

  2. In the Edit field, change the author which will be shown in the footer of the book website.

Need some help?

The first line of your _config.yml should look like

author: <your_name>, built with <a href="https://teachbooks.io">TeachBooks</a> and <a href="https://jupyterbook.org/">Jupyter Book</a>, <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank" rel="license noopener noreferrer"">CC BY 4.0<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg" alt=""></a>

  1. In the Edit field, change the title of your homepage which will under the logo and above the table of contents

Need some help?

The 21st line of your _config.yml should look like

        text: <your_title>

  1. In the Edit field, change the repository url which will be used to allow other people to open your repository, suggest edits and open issues as shown in top right corner of the built book under .

Need some help?

The 24th line of your _config.yml should look like

      repository_url: "https://github.com/<your_username>/<your_repository>"

  1. Click Commit changes

  2. Add a message and description of your change

  3. Select Commit directly to the main branch (this adds your change your change to the default version instead of making a new one)

  4. Click Commit changes

  5. Go to Actions - The most recent workflow run Update _config.yml / the commit message of the commit you just made - Wait for it to finish - In the summary, click on the link of your book shown in the table Branches deployed and under Primary book at root

  6. Do you see your change? If you don’t see it click CTRL+F5/Control+F5to refresh the page.

Check your understanding

Before moving on to the next exercise, make sure you understand the following:

  • What is this special _config.yml file?

  • Changes in _config.yml can have effect on multiple pages in the book

  • The _config.yml is generally not used for adding content