Skip to content

Adds Mermaid to the docs configuration#236

Merged
degville merged 1 commit intocanonical:mainfrom
degville:gm-p07-enable-mermaid
Apr 1, 2026
Merged

Adds Mermaid to the docs configuration#236
degville merged 1 commit intocanonical:mainfrom
degville:gm-p07-enable-mermaid

Conversation

@degville
Copy link
Copy Markdown
Collaborator

@degville degville commented Apr 1, 2026

(cc @ernestl)

With this configuration change, we can now embed Mermaid diagrams within our documentation.

In MyST, diagrams are placed within ```{mermaid} ``` blocks, such as for the following timeline:

%%{init: {"theme":"forest"}}%%
timeline
    title Ubuntu recent releases

    2020 : 20.04 LTS (Focal Fossa) : 20.10 (Groovy Gorilla)
    2021 : 21.04 (Hirsute Hippo) : 21.10 (Impish Indri)   
    2022 : 22.04 LTS (Jammy Jellyfish) : 22.10 (Kinetic Kudu)
    2023 : 23.04 (Lunar Lobster) : 23.10 (Mantic Minotaur)
    2024 : 24.04 LTS (Noble Numbat) : 24.10 (Oracular Oriole)
    2025 : 25.04 (Plucky Puffin)

See https://canonical-starter-pack.readthedocs-hosted.com/stable/how-to/diagrams-as-code-mermaid for further details.

@degville degville merged commit 13f89e8 into canonical:main Apr 1, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant