Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 1.34 KB

figures.md

File metadata and controls

56 lines (40 loc) · 1.34 KB

Figures and captions

Reflex has support for figures and captions in two formats:

figure and figcaption HTML elements:

<figure>
    <img src="img.jpg" />
    <figcaption>Caption</figcaption>
</figure>

A div with figure class and p with caption class:

<div class="figure">
    <img src="img.jpg">
    <p class="caption">Caption</p>
</div>

Alignment

Add align-left, align-center or align-right class to align figures to left, center and right respectively.

Border

Add border class to add a border around the figure and caption.

Markdown

markdown-captions is recommended as it generates semantic figure and figcaption HTML elements, with support for tooltips and HTML classes.

Install the markdown-captions dependency, then add it to your pelicanconf.py:

MARKDOWN = {
    "extensions": [
        "markdown_captions",
    ],
}

An example of a center-aligned figure with caption, tooltip and border using markdown-captions:

![Caption](img.jpg "Tooltip on hover"){: .align-center .border}

For large images you can make them clickable to open full size:

[
![Caption](img.jpg "Click to see full size"){: .align-center .border}
](img.jpg "Click to see full size")