Added exercise

This commit is contained in:
Tom van Woudenberg 2024-12-13 15:49:11 +01:00
parent da2c80ece2
commit 5abb5acab5
5 changed files with 11 additions and 17 deletions

View file

@ -18,6 +18,7 @@ sphinx:
- jupyterbook_patches
- teachbooks_sphinx_grasple
- sphinx_image_inverter
- sphinx_exercise
config:
html_js_files:
- https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js

View file

@ -12,8 +12,7 @@ Now that you've been introduced to the basics of a Jupyter Book, let's make one!
## 1. Create a GitHub account
TeachBooks relies of freely available services from GitHub to store files online, carry out the book-building process and host your book as a website. All you need to get started is a GitHub account (not counted in the 10 clicks 🤭).
```{admonition} Task 1
:class: tip
```{exercise} Task 1
If you don't already have one, create a GitHub account here by visiting [github.com/signup](https://github.com/signup).
```
@ -21,8 +20,7 @@ If you don't already have one, create a GitHub account here by visiting [github.
## 2. Use the template---it's really just 10 clicks!
Now, let's make a book: we've made a template on GitHub which carries out _most_ of the technical steps required to create a book and put it online. Instructions for using the template are in the `README` of the TeachBooks Template repository on GitHub, which is by default visible on the repository homepage.
```{admonition} Task 2
:class: tip
```{exercise} Task 2
Go to the [TeachBooks Template repository on GitHub](https://github.com/TeachBooks/template) and follow the instructions to create your book. At the end, it should be visible at `<your_username>.github.io/<book>`. When finished, come back to this page.
```
@ -30,8 +28,7 @@ Go to the [TeachBooks Template repository on GitHub](https://github.com/TeachBoo
## 3. Let's practice!
Getting used to the syntax of writing in a Jupyter Book can be a bit daunting at the start, not to mention becoming familiar with the various tools and workflows required. To help make the learning curve somewhat easier to travel, a number of exercises have been prepared for you as part of an introductory **workshop**. The exercises are designed such that no prior experience with any tools or programming is required, as long as you have read the preceding introductory pages.
```{admonition} Task 3
:class: tip
```{exercise} Task 3
Work through the sections attached to this page (you can find them in the left sidebar).
```

View file

@ -2,4 +2,6 @@
Let's start with the most basic edit: add some text to a file and see that the website is updated. This exercise is ready for you at https://teachbooks.io/template/exercises/001.
Can you add some content to the intro page?
`COPY OF TEXT IN TEMPLATE`

View file

@ -1,12 +1,5 @@
# Exercise 2: Add something to the table of contents
# Exercise 1: Add a new file to the table of contents
The first exercise showed
```{admonition} Check your understanding
:class: tip
Before moving on to the next exercise, make sure you understand the following:
1. Where is the book metadata stored?
...
```
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!
Can you create a file named `my_first_file.md` and add it successfully to the book?

View file

@ -11,4 +11,5 @@ sphinx-image-inverter
--extra-index-url https://gitlab.tudelft.nl/api/v4/projects/11239/packages/pypi/simple
sphinx-thebe ~= 0.9.9
docutils==0.17.1
docutils==0.17.1
sphinx-exercise