From dc4e7fbf5b33e4a020c23929193bc8b6e6192e62 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Fri, 13 Dec 2024 16:48:50 +0100 Subject: [PATCH] fix formatting --- book/exercises/001.md | 5 +++-- book/exercises/002.md | 6 +++--- book/exercises/003.md | 9 +++++---- book/exercises/004.md | 3 ++- 4 files changed, 13 insertions(+), 10 deletions(-) diff --git a/book/exercises/001.md b/book/exercises/001.md index 4191b53..2fc2ce7 100644 --- a/book/exercises/001.md +++ b/book/exercises/001.md @@ -10,10 +10,11 @@ Can you add some content to the intro page? 4. Add a message and description of your change. With this `commit` you save your changes to the git-timeline. Any commit can always be reverted. Therefore, it's useful to shortly explain what is included in your commit. Later on, you'll make commits which may contain changes to many different files. In that case, a descriptive commit message and description is even more useful! 5. Select `Commit directly to the main branch` (this adds your change your change to the default version instead of making a new one) 6. Click `Commit changes`. -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` +7. Go to {octicon}`play;1em` `Actions` - The most recent workflow run `Update intro.md / 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` 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!). -```{note} Check your understanding +```{admonition} Check your understanding +:class: note Before moving on to the next exercise, make sure you understand the following: - Where are the contents of the book stored? diff --git a/book/exercises/002.md b/book/exercises/002.md index fe2bbcf..db3a018 100644 --- a/book/exercises/002.md +++ b/book/exercises/002.md @@ -27,7 +27,7 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean id diam non maur ````{admonition} Need some help? :class: tip, dropdown Your `_toc.yml` should look like -```yml +```yaml format: jb-book root: intro.md @@ -46,7 +46,6 @@ parts: - 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 @@ -59,7 +58,8 @@ 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. -```{note} Check your understanding +```{admonition} Check your understanding +:class: note Before moving on to the next exercise, make sure you understand the following: - Are all files in the repository added to the website? diff --git a/book/exercises/003.md b/book/exercises/003.md index 8fe17c2..84e36d8 100644 --- a/book/exercises/003.md +++ b/book/exercises/003.md @@ -9,7 +9,7 @@ Can you edit the repository url defined in the `_config.yml`, change the title s ````{admonition} Need some help? :class: tip, dropdown The first line of your `_config.yml` should look like -```yml +```yaml author: , built with TeachBooks and Jupyter Book, CC BY 4.0 ``` ```` @@ -17,7 +17,7 @@ author: , built with TeachBooks a ````{admonition} Need some help? :class: tip, dropdown The 21st line of your `_config.yml` should look like -```yml +```yaml text: ``` ```` @@ -25,7 +25,7 @@ The 21st line of your `_config.yml` should look like ````{admonition} Need some help? :class: tip, dropdown The 24th line of your `_config.yml` should look like -```yml +```yaml repository_url: "https://github.com//" ``` ```` @@ -36,7 +36,8 @@ The 24th line of your `_config.yml` should look like 9. Go to {octicon}`play;1em` `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` 10. Do you see your change? If you don't see it click `CTRL`+`F5`/`Control`+`F5`to refresh the page. -```{note} Check your understanding +```{admonition} Check your understanding +:class: note Before moving on to the next exercise, make sure you understand the following: - What is this special `_config.yml` file? diff --git a/book/exercises/004.md b/book/exercises/004.md index 028d8fc..fff7d37 100644 --- a/book/exercises/004.md +++ b/book/exercises/004.md @@ -16,7 +16,8 @@ Can you make a new `branch` of your book with an additional file `file_on_new_ve 10. 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, you should now see multiple Branches. Click on the link of your new branch ``1-` 11. Do you see your change? If you don't see it click `CTRL`+`F5`/`Control`+`F5`to refresh the page. -```{note} Check your understanding +```{admonition} Check your understanding +:class: note Before moving on to the next exercise, make sure you understand the following: - What is the purpose of creating a new branch in your repository?