updated content

This commit is contained in:
Katia Gatt 2025-03-22 17:30:17 +01:00
parent b33df99f2b
commit 36cd954095

View file

@ -41,19 +41,19 @@ Then, you can reference this section in three ways:
```md ```md
My favourite exercise was {ref}`exercise_1`. My favourite exercise was {ref}`exercise_1`.
``` ```
This will display: *My favourite exercise was Exercise 1: First file edit.* This will display: My favourite exercise was {ref}`exercise_1`.
- Specifying a custom title text: - Specifying a custom title text:
```md ```md
My favourite exercise was {ref}`the first one <exercise_1>`. My favourite exercise was {ref}`the first one <exercise_1>`.
``` ```
This will display: *My favourite exercise was the first one.* This will display: My favourite exercise was {ref}`the first one <exercise_1>`.
- Using Markdown syntax: - Using Markdown syntax:
```md ```md
My favourite exercise was [this one](exercise_1). My favourite exercise was [this one](exercise_1).
``` ```
This will display: *My favourite exercise was this one.* This will display: My favourite exercise was [this one](exercise_1).
## 2. Referencing an Equation ## 2. Referencing an Equation
@ -72,6 +72,10 @@ You can then reference this equation using:
Equation {eq}`eq-example` Equation {eq}`eq-example`
``` ```
This will display: Equation {eq}`eq-example`.
## 3. Referencing a Table ## 3. Referencing a Table
To reference a table, assign a label when defining it: To reference a table, assign a label when defining it:
@ -112,7 +116,25 @@ And refer to it using:
Figure {numref}`fig-example` Figure {numref}`fig-example`
``` ```
## 5. Commit Your Changes ## 5. Referencing a Link
To reference a link, use the following syntax:
```md
[Text to display](https://teachbooks.github.io/template/)
```
For example, you can write:
```md
Here is the [link to the template](https://teachbooks.github.io/template/).
```
This wil display: Here is the [link to the template](https://teachbooks.github.io/template/).
## 6. Commit Your Changes
1. Once you have added your references, commit your changes to the repository. 1. Once you have added your references, commit your changes to the repository.
2. Click the green `Commit changes` button. 2. Click the green `Commit changes` button.
@ -124,5 +146,5 @@ Figure {numref}`fig-example`
Before moving on to the next exercise, make sure you understand the following: Before moving on to the next exercise, make sure you understand the following:
- How do you reference another chapter or section? - How do you reference another chapter or section?
- How do you create a reference to an equation? - How do you create a reference to an equation, table or figure in your book?
- How can you refer to a table or a figure in your book? - How do you reference a link?