admin2/template
1
0
Fork 0
mirror of https://github.com/TeachBooks/template.git synced 2026-11-12 22:25:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

WIP

Browse source
This commit is contained in:
Tom van Woudenberg 2024-12-13 15:49:45 +01:00
parent d83e4018ad
commit 505dd3ccf5
2 changed files with 18 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

3
book/exercises/001.md
View file

@ -13,8 +13,7 @@ Can you add some content to the intro page?
7. Go to {octicon}`play;1em` `Actions` - The most recent workflow run `Update intro.md / the commit messageof 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`
8. Do you see your change? If you don't see it click `CTRL`+`F5`/`Control`+`F5`to refresh the page (your browser keeps a cached version of website you recently visit, but we actually want the most up-to-date version!).
```{admonition} Check your understanding
:class: tip
```{note} Check your understanding
Before moving on to the next exercise, make sure you understand the following:
1. Where are the contents of the book stored?

22
book/exercises/002.md
View file

@ -1,4 +1,4 @@
# Exercise 1: Add a new file to the table of contents
# Exercise 2: Add a new file to the table of contents
Let's continue by adding one additional step. Let's add a file to the table of contents! the `_toc.yml` contains a list of all the files to be shown in your book-website. Let's create a new file and add it to that list!
@ -28,7 +28,9 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean id diam non maur
:class: tip, dropdown
Your `_toc.yml` should look like
```yml
...
format: jb-book
root: intro.md
parts:
- caption: Contents
chapters:
@ -36,7 +38,18 @@ parts:
sections:
- file: some_content/text_and_code.ipynb
- file: my_first_file.md
...
- file: exercises/exercises
sections:
- file: exercises/001.md
- file: exercises/002.md
- file: exercises/003.md
- file: exercises/004.md
- file: exercises/005.md
- file: exercises/006.md
- file: exercises/007.md
- file: references.md
- file: changelog.md
- file: credits.md
```
````
12. Click `Commit changes`
@ -46,8 +59,7 @@ parts:
16. Go to {octicon}`play;1em` `Actions` - The most recent workflow run `Update _toc.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` (getting bored of waiting, there'll be exercising on doing this locally which prevents you from waiting)
17. Do you see your change? If you don't see it click `CTRL`+`F5`/`Control`+`F5`to refresh the page (your browser keeps a cached version of website you recently visit, but we actually want the most up-to-date version!).
```{admonition} Check your understanding
:class: tip
```{note} Check your understanding
Before moving on to the next exercise, make sure you understand the following:
1. Are all files in the repository added to the website?