manual_teachbooks/book/basic-features/figures.md

1.5 KiB

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. 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:

---
width: 50%
name: demoexample1
align: right
---
example 1: width (50%) as percentage, align right

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
    ```

---
figclass: margin
width: 50%
name: demoexample2
---
example 2:including figclass: margin

We made a useful tool to make your figures, just specify all information and the code is produced for you: