Skip to content

Commit aa25e0a

Browse files
author
SpacemacsBot
committed
[bot] "documentation_updates" Mon Feb 9 20:55:56 UTC 2026
1 parent 6908891 commit aa25e0a

File tree

2 files changed

+35
-30
lines changed

2 files changed

+35
-30
lines changed

layers/+lang/mermaid/README.org

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
#+TITLE: Mermaid layer
22

3+
#+TAGS: layer|uncategorized
4+
35
[[file:img/logo.svg]]
46

5-
* Table of Contents :TOC_5_gh:noexport:
7+
* Table of Contents :TOC_5_gh:noexport:
68
- [[#description][Description]]
79
- [[#features][Features:]]
810
- [[#installation][Installation]]
9-
- [[#key-bindings][Key Bindings]]
11+
- [[#key-bindings][Key bindings]]
1012

1113
* Description
1214
This layer adds support for [[https://mermaid.js.org/][Mermaid]] diagrams to Spacemacs. Mermaid is
@@ -21,8 +23,8 @@ set it in your =user-config= function of your =~/.spacemacs= file.
2123
For example, the following diagram can be defined as follows:
2224

2325
#+BEGIN_SRC mermaid
24-
sequenceDiagram
25-
Server<<->>Client: Hello
26+
sequenceDiagram
27+
Server<<->>Client: Hello
2628
#+END_SRC
2729

2830
** Features:
@@ -39,9 +41,9 @@ Add the layer to your =~/.spacemacs= file:
3941

4042
To compile mermaid diagram, please install [[https://github.com/mermaid-js/mermaid-cli][mmdc]] command-line tool.
4143

42-
* Key Bindings
44+
* Key bindings
4345

44-
| Key Binding | Description |
46+
| Key binding | Description |
4547
|-------------+----------------------------|
4648
| ~SPC m c c~ | Compile Mermaid diagram |
4749
| ~SPC m c f~ | Compile Mermaid file |

layers/LAYERS.org

Lines changed: 27 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,6 @@
9393
- [[#dhall][Dhall]]
9494
- [[#fountain][Fountain]]
9595
- [[#graphviz][Graphviz]]
96-
- [[#mermaid][Mermaid]]
9796
- [[#html][HTML]]
9897
- [[#json][JSON]]
9998
- [[#jsonnet][Jsonnet]]
@@ -193,6 +192,8 @@
193192
- [[#epub][Epub]]
194193
- [[#pdf][PDF]]
195194
- [[#speed-reading][Speed Reading]]
195+
- [[#readmeorg-files-that-need-proper-tags][README.org files that need proper tags]]
196+
- [[#mermaid][Mermaid]]
196197
- [[#source-control][Source control]]
197198
- [[#git][Git]]
198199
- [[#perforce][Perforce]]
@@ -1319,29 +1320,6 @@ Features:
13191320
- Control of the graphviz compiler directly from emacs.
13201321
- Support for formatting =.dot= files automatically.
13211322

1322-
**** Mermaid
1323-
[[file:+lang/mermaid/README.org][+lang/mermaid/README.org]]
1324-
1325-
This layer adds support for [[https://mermaid-js.github.io/][Mermaid]] diagrams
1326-
to Spacemacs. Mermaid is a JavaScript-based diagramming and charting tool that
1327-
renders Markdown-inspired text definitions to create and display diagrams.
1328-
1329-
For help with how to use Mermaid, see the [[https://mermaid.js.org/intro/getting-started][reference guide]].
1330-
1331-
The official file extension supported by this layer is =.mmd=. If you want something else,
1332-
set it in your =user-config= function of your =~/.spacemacs= file.
1333-
1334-
For example, the following diagram can be defined as follows:
1335-
1336-
#+BEGIN_SRC mermaid
1337-
sequenceDiagram
1338-
Server<<->>Client: Hello
1339-
#+END_SRC
1340-
1341-
- Syntax highlighting for Mermaid files (with .mmd extension)
1342-
- Diagram preview on region/buffer/file
1343-
- Key bindings for compiling and changing output types
1344-
13451323
**** HTML
13461324
[[file:+lang/html/README.org][+lang/html/README.org]]
13471325

@@ -2611,6 +2589,31 @@ A speed reading mode for Emacs.
26112589
Features:
26122590
- Support for =speed-reading= of arbitrary texts
26132591

2592+
* README.org files that need proper tags
2593+
** Mermaid
2594+
[[file:+lang/mermaid/README.org][+lang/mermaid/README.org]]
2595+
2596+
This layer adds support for [[https://mermaid.js.org/][Mermaid]] diagrams to Spacemacs. Mermaid is
2597+
a JavaScript-based diagramming and charting tool that renders
2598+
Markdown-inspired text definitions to create and display diagrams.
2599+
2600+
For help with how to use Mermaid, see the [[https://mermaid.js.org/intro/getting-started][reference guide]].
2601+
2602+
The official file extension supported by this layer is =.mmd=. If you want something else,
2603+
set it in your =user-config= function of your =~/.spacemacs= file.
2604+
2605+
For example, the following diagram can be defined as follows:
2606+
2607+
#+BEGIN_SRC mermaid
2608+
sequenceDiagram
2609+
Server<<->>Client: Hello
2610+
#+END_SRC
2611+
2612+
Features:
2613+
- Syntax highlighting for Mermaid files (with .mmd extension)
2614+
- Diagram preview on region/buffer/file
2615+
- Key bindings for compiling and changing output types
2616+
26142617
* Source control
26152618
** Git
26162619
[[file:+source-control/git/README.org][+source-control/git/README.org]]

0 commit comments

Comments
 (0)