alrayyes/wiki
1
0
Fork 0
mirror of https://github.com/alrayyes/wiki.git synced 2024-11-22 19:46:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: add support for mermaid diagrams (#244)

Browse source
This commit is contained in:
Brendan Ang 2022-11-28 02:53:52 +08:00 committed by GitHub
parent 66f3e249fe
commit 5f3d430699
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 31 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
content/notes/config.md
View file

@ -57,6 +57,9 @@ enableRecentNotes: false
enableGitHubEdit: true enableGitHubEdit: true
GitHubLink: https://github.com/jackyzha0/quartz/tree/hugo/content GitHubLink: https://github.com/jackyzha0/quartz/tree/hugo/content
# whether to render mermaid diagrams
enableMermaid: true
# whether to use Operand to power semantic search # whether to use Operand to power semantic search
# IMPORTANT: replace this API key with your own if you plan on using # IMPORTANT: replace this API key with your own if you plan on using
# Operand search! # Operand search!

1
data/config.yaml
View file

@ -11,6 +11,7 @@ enableFooter: true
enableContextualBacklinks: true enableContextualBacklinks: true
enableRecentNotes: false enableRecentNotes: false
enableGitHubEdit: true enableGitHubEdit: true
enableMermaid: true
GitHubLink: https://github.com/jackyzha0/quartz/tree/hugo/content GitHubLink: https://github.com/jackyzha0/quartz/tree/hugo/content
search: search:
enableSemanticSearch: false enableSemanticSearch: false

4
layouts/_default/_markup/render-codeblock-mermaid.html Normal file
View file

@ -0,0 +1,4 @@
<div class="mermaid">
{{- .Inner | safeHTML }}
</div>
{{ .Page.Store.Set "hasMermaid" true }}

15
layouts/partials/head.html
View file

@ -51,6 +51,8 @@
{{end}} {{end}}
{{partial "katex.html" .}} {{partial "katex.html" .}}
{{partial "mermaid.html" .}}
<script src="https://unpkg.com/@floating-ui/core@0.7.3"></script> <script src="https://unpkg.com/@floating-ui/core@0.7.3"></script>
<script src="https://unpkg.com/@floating-ui/dom@0.5.4"></script> <script src="https://unpkg.com/@floating-ui/dom@0.5.4"></script>
{{ $popover := resources.Get "js/popover.js" | resources.Fingerprint "md5" | {{ $popover := resources.Get "js/popover.js" | resources.Fingerprint "md5" |
@ -145,6 +147,19 @@
} }
{{end}} {{end}}
{{if $data.enableMermaid | default $.Site.Data.config.enableMermaid}}
var els = document.getElementsByClassName("mermaid");
if (els.length > 0) {
import('https://unpkg.com/mermaid@9/dist/mermaid.esm.min.mjs').then(
(obj) => {
// init forces mermaid to render mermaid markdown without waiting
// for DOMContentLoaded event
obj.default.init();
}
)
}
{{end}}
} }
const init = (doc = document) => { const init = (doc = document) => {

8
layouts/partials/mermaid.html Normal file
View file

@ -0,0 +1,8 @@
{{if $.Site.Data.config.enableMermaid}}
{{ if .Page.Store.Get "hasMermaid" }}
<script type="module">
import mermaid from 'https://unpkg.com/mermaid@9/dist/mermaid.esm.min.mjs';
mermaid.initialize({ startOnLoad: true });
</script>
{{ end }}
{{ end }}