Skip to content

Commit a3af681

Browse files
committed
Close #2303 with updated information on Mermaid diagram
1 parent 742a202 commit a3af681

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

_includes/head/custom.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
<!-- Support for Mermaid -->
2020
<script type="module">
2121
import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
22-
mermaid.initialize({startOnLoad:true,theme:'neutral'});
22+
mermaid.initialize({startOnLoad:true, theme:'default'});
2323
await mermaid.run({querySelector:'code.language-mermaid'});
2424
</script>
2525

_pages/markdown.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ redirect_from:
4848

4949
## MathJax
5050

51-
Support for MathJax Version 3.0 is included in the template:
51+
Support for MathJax (version 3.* via [jsDelivr](https://www.jsdelivr.com/)) is included in the template:
5252

5353
$$
5454
\displaylines{
@@ -64,7 +64,7 @@ The default delimiters of `$$...$$` and `\\[...\\]` are supported for displayed
6464
**Note** that since Academic Pages uses Markdown which cases some interference with MathJax and LaTeX for escaping characters and new lines, although [some workarounds exist](https://math.codidact.com/posts/278763/278772#answer-278772). In some cases, such as when you are including MathJax in a `citation` field for publications, it may be necessary to use `\(...\)` for inline delineation.
6565

6666
## Mermaid diagrams
67-
Academic Pages includes support for [Mermaid diagrams](https://mermaid.js.org/) and in addition to their [tutorials](https://mermaid.js.org/ecosystem/tutorials.html) and [GitHub documentation](https://github.com/mermaid-js/mermaid) the basic syntax is as follows:
67+
Academic Pages includes support for [Mermaid diagrams](https://mermaid.js.org/) (version 11.* via [jsDelivr](https://www.jsdelivr.com/)) and in addition to their [tutorials](https://mermaid.js.org/ecosystem/tutorials.html) and [GitHub documentation](https://github.com/mermaid-js/mermaid) the basic syntax is as follows:
6868

6969
```markdown
7070
```mermaid
@@ -73,13 +73,27 @@ Academic Pages includes support for [Mermaid diagrams](https://mermaid.js.org/)
7373
```
7474
```
7575

76-
Which produces the following plot:
76+
Which produces the following plot with the [default theme](https://mermaid.js.org/config/theming.html) applied:
7777

7878
```mermaid
7979
graph LR
8080
A-->B
8181
```
8282

83+
While a more advanced plot with the `forest` theme applied looks like the following:
84+
85+
```mermaid
86+
---
87+
config:
88+
theme: 'forest'
89+
---
90+
graph TD;
91+
A-->B;
92+
A-->C;
93+
B-->D;
94+
C-->D;
95+
```
96+
8397
## Markdown guide
8498

8599
Academic Pages uses [kramdown](https://kramdown.gettalong.org/index.html) for Markdown rendering, which has some differences from other Markdown implementations such as GitHub's. In addition to this guide, please see the [kramdown Syntax page](https://kramdown.gettalong.org/syntax.html) for full documentation.

0 commit comments

Comments
 (0)