manual_teachbooks/book/basic-features/figures.md
2024-05-30 11:41:46 +02:00

75 lines
1.5 KiB
Markdown

# Figures
To add a figure, just copy the figure to the correct directory. Then, in your markdown file, include the figure as follows:
````
```{figure} <figurename>.png/.jpg
---
height/width: <height or width in pixels>
name: <name of the figure>
---
<Figure caption>
```
````
Using the name label, you can refer to the figure as done with {numref}`Figure {number} <demoexample1>`.
You can find more documentation on including figures [here](https://jupyterbook.org/en/stable/content/figures.html). Some examples with different settings:
````
```{figure} ../images/TUDelft_logo_rgb.png
---
width: 50%
name: demoexample1
align: right
---
example 1: width (50%) as percentage, align right
```
````
provides the output:
<br>
```{figure} ../images/TUDelft_logo_rgb.png
---
width: 50%
name: demoexample1
align: right
---
example 1: width (50%) as percentage, align right
```
<br>
including a figclass sets the figure to the column at the right.
````
```{figure} ../images/TUDelft_logo_rgb.png
---
figclass: margin
width: 50%
name: demoexample2
---
example 2:including figclass: margin
```
````
<br>
```{figure} ../images/TUDelft_logo_rgb.png
---
figclass: margin
width: 50%
name: demoexample2
---
example 2:including figclass: margin
```
<br>
We made a useful tool to make your figures, just specify all information and the code is produced for you:
<div id="figuur_formulier">
</div>
<div id="listContainer">
</div>