Skip to content

Commit 69182a1

Browse files
committed
feat(mermaid): add link to docs (closes #5378)
1 parent 8a63f20 commit 69182a1

File tree

7 files changed

+72
-29
lines changed

7 files changed

+72
-29
lines changed

apps/client/src/services/in_app_help.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ export const byNoteType: Record<Exclude<NoteType, "book">, string | null> = {
1010
file: null,
1111
image: null,
1212
launcher: null,
13-
mermaid: null,
13+
mermaid: "s1aBHPd79XYj",
1414
mindMap: null,
1515
noteMap: null,
1616
relationMap: null,

apps/server/src/assets/doc_notes/en/User Guide/!!!meta.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams.html

Lines changed: 33 additions & 25 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams/Syntax reference.dat

Whitespace-only changes.

docs/User Guide/!!!meta.json

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8838,6 +8838,13 @@
88388838
"value": "bx bx-selection",
88398839
"isInheritable": false,
88408840
"position": 20
8841+
},
8842+
{
8843+
"type": "relation",
8844+
"name": "internalLink",
8845+
"value": "WWgeUaBb7UfC",
8846+
"isInheritable": false,
8847+
"position": 30
88418848
}
88428849
],
88438850
"format": "markdown",
@@ -8921,6 +8928,33 @@
89218928
"dataFileName": "ELK layout_ELK on.svg"
89228929
}
89238930
]
8931+
},
8932+
{
8933+
"isClone": false,
8934+
"noteId": "WWgeUaBb7UfC",
8935+
"notePath": [
8936+
"pOsGYCXsbNQG",
8937+
"KSZ04uQ2D1St",
8938+
"s1aBHPd79XYj",
8939+
"WWgeUaBb7UfC"
8940+
],
8941+
"title": "Syntax reference",
8942+
"notePosition": 40,
8943+
"prefix": null,
8944+
"isExpanded": false,
8945+
"type": "webView",
8946+
"mime": "",
8947+
"attributes": [
8948+
{
8949+
"type": "label",
8950+
"name": "webViewSrc",
8951+
"value": "https://mermaid.js.org/intro/syntax-reference.html",
8952+
"isInheritable": false,
8953+
"position": 10
8954+
}
8955+
],
8956+
"dataFileName": "Syntax reference.dat",
8957+
"attachments": []
89248958
}
89258959
]
89268960
},

docs/User Guide/User Guide/Note Types/Mermaid Diagrams.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# Mermaid Diagrams
2+
> [!TIP]
3+
> For a quick understanding of the Mermaid syntax, see <a class="reference-link" href="Mermaid%20Diagrams/Syntax%20reference.dat">Syntax reference</a> (official documentation).
4+
25
<figure class="image image-style-align-center"><img style="aspect-ratio:886/663;" src="2_Mermaid Diagrams_image.png" width="886" height="663"></figure>
36

47
Trilium supports Mermaid, which adds support for various diagrams such as flowchart, sequence diagram, class diagram, state diagram, pie charts, etc., all using a text description of the chart instead of manually drawing the diagram.
58

6-
For the official documentation of Mermaid.js see [mermaid.js.org/intro/](https://mermaid.js.org/intro/).
7-
89
## Layouts
910

1011
Depending on the chart being edited and user preference, there are two layouts supported by the Mermaid note type:

docs/User Guide/User Guide/Note Types/Mermaid Diagrams/Syntax reference.dat

Whitespace-only changes.

0 commit comments

Comments
 (0)