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

fix broken JB links

Browse source
This commit is contained in:
Tom van Woudenberg 2025-11-03 13:36:54 +01:00
parent 6acb3f7d1c
commit fa19165fec
7 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

2
book/exercises/001.md
View file

@ -8,7 +8,7 @@ Can you add some content to the intro page?
:::::: ::::::
1. Go to the the file `book/intro.md` on your GitHub repository (`https://github.com/<your_username>/<your_repo_name>`) - {octicon}`code;1em` `Code` - `Book` - `intro.md` - {octicon}`pencil;1em` `Edit this file` 1. Go to the the file `book/intro.md` on your GitHub repository (`https://github.com/<your_username>/<your_repo_name>`) - {octicon}`code;1em` `Code` - `Book` - `intro.md` - {octicon}`pencil;1em` `Edit this file`
2. Add some text. Feeling brave? Have a look at the [MyST cheat sheet](https://jupyterbook.org/en/stable/reference/cheatsheet.html). Don't worry if that feels daunting, there will be exercises on this! 2. Add some text. Feeling brave? Have a look at the [MyST cheat sheet](https://jupyterbook.org/v1/reference/cheatsheet.html). Don't worry if that feels daunting, there will be exercises on this!
3. Click `Commit changes` 3. Click `Commit changes`
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! 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) 5. Select `Commit directly to the main branch` (this adds your change your change to the default version instead of making a new one)

2
book/exercises/003.md
View file

@ -12,7 +12,7 @@ Can you edit the repository url defined in the `_config.yml`, change the title s
:class: tip, dropdown :class: tip, dropdown
The first line of your `_config.yml` should look like The first line of your `_config.yml` should look like
```yaml ```yaml
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> author: <your_name>, built with <a href="https://teachbooks.io">TeachBooks</a> and <a href="https://jupyterbook.org/v1">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>
``` ```
```` ````
3. In the `Edit` field, change the title of your homepage which will under the logo and above the table of contents 3. In the `Edit` field, change the title of your homepage which will under the logo and above the table of contents

2
book/syntax_exercises.md
View file

@ -4,4 +4,4 @@ The previous exercise guide you through making your own book following the Teach
As user type 3 you will work primarily in `.md` (Markdown) or `.ipynb`(Jupyter Notebook) files. In Jupyter Book, `.md` files contain text-based content with formatting, while `ipynb` files contain both text and executable code cells. `.md` files are much easier to edit online, so let's start with those! As user type 3 you will work primarily in `.md` (Markdown) or `.ipynb`(Jupyter Notebook) files. In Jupyter Book, `.md` files contain text-based content with formatting, while `ipynb` files contain both text and executable code cells. `.md` files are much easier to edit online, so let's start with those!
The more you write, the more different types of content you'll want to use. [JupyterBook itself provides a cheatsheet](https://jupyterbook.org/en/stable/reference/cheatsheet.html) which will come in handy! The more you write, the more different types of content you'll want to use. [JupyterBook itself provides a cheatsheet](https://jupyterbook.org/v1/reference/cheatsheet.html) which will come in handy!

2
book/syntax_exercises/007.md
View file

@ -8,7 +8,7 @@ Can you structure your page with a title and (sub)sections?
```{tip} ```{tip}
More useful Markdown syntax is explained in the [MyST cheat sheet](https://jupyterbook.org/en/stable/reference/cheatsheet.html). More useful Markdown syntax is explained in the [MyST cheat sheet](https://jupyterbook.org/v1/reference/cheatsheet.html).
``` ```

2
book/syntax_exercises/008.md
View file

@ -22,7 +22,7 @@ Unless you are using a file format like `*.svg`, the raw contents of a visual me
4. Now let's add the figure to a chapter. Navigate to the file you want to work in (for example `book/some_content/overview.md`) and make sure you're in the same branch as where you've added your figure. 4. Now let's add the figure to a chapter. Navigate to the file you want to work in (for example `book/some_content/overview.md`) and make sure you're in the same branch as where you've added your figure.
5. Copy this syntax and adjust the file name, width, alignment and caption (for more options see the [JupyterBook documentation](https://jupyterbook.org/en/stable/content/figures.html#figure-parameters)): 5. Copy this syntax and adjust the file name, width, alignment and caption (for more options see the [JupyterBook documentation](https://jupyterbook.org/v1/content/figures.html#figure-parameters)):
````md ````md
```{figure} figures/<new_figure>.png ```{figure} figures/<new_figure>.png

2
book/syntax_exercises/009.md
View file

@ -7,7 +7,7 @@ Can you write and format equations correctly in your book?
:::::: ::::::
```{tip} ```{tip}
Using properly formatted equations makes mathematical expressions clearer and more professional. More details can be found in the [JupyterBook documentation](https://jupyterbook.org/en/stable/content/math.html). Using properly formatted equations makes mathematical expressions clearer and more professional. More details can be found in the [JupyterBook documentation](https://jupyterbook.org/v1/content/math.html).
``` ```
## Writing equations ## Writing equations

2
book/syntax_exercises/011.md
View file

@ -7,7 +7,7 @@ Can you create internal references to other sections, equations, tables, figures
:::::: ::::::
```{tip} ```{tip}
Referencing elements properly ensures that readers can navigate your book more easily. More details can be found in the [JupyterBook documentation](https://jupyterbook.org/en/stable/content/references.html). Referencing elements properly ensures that readers can navigate your book more easily. More details can be found in the [JupyterBook documentation](https://jupyterbook.org/v1/content/references.html).
``` ```
## Referencing a Chapter or Section ## Referencing a Chapter or Section