Skip to content

Commit

Permalink
docs: Fix casing in headlines
Browse files Browse the repository at this point in the history
  • Loading branch information
jonasehrlich committed May 5, 2024
1 parent ddfd8d3 commit e1bd4aa
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Use a normal image directive to add the behavior to images.
:::{image} large-diagram.drawio.svg
:::

### PlantUML diagram
### PlantUML Diagram

::: {important}
The lightbox does not work with the *plantuml_output_format* `svg_obj`. All other formats are supported.
Expand Down Expand Up @@ -85,10 +85,11 @@ Use the `uml` directive from the `sphinxcontrib.plantuml` extension to add the e
:caption: Caption with **bold** and *italic*
:::

### Mermaid diagram
### Mermaid Diagram

::: {important}
The lightbox effect is only supported if *mermaid_output_format* is set to `png`. Other formats either produce inline SVG or are handled by `mermaid-js` in the browser directly.
The lightbox effect is only supported if *mermaid_output_format* is set to `png`.
Other formats either produce inline SVG or are handled by `mermaid-js` in the browser directly.

Using the *mermaid_output_format* `png` requires the `mermaid-cli` to be available.
:::
Expand Down

0 comments on commit e1bd4aa

Please sign in to comment.