Skip to content

Commit 22daa69

Browse files
committed
Update documentation
1 parent 3fa9dae commit 22daa69

1 file changed

Lines changed: 56 additions & 0 deletions

File tree

docs-src/docs/Inline Editor.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,66 @@ Emoji shortcodes like `:smile:` or `:seedling:` are rendered as their emoji char
8383

8484
Mermaid diagram code blocks (` ```mermaid `) are rendered as inline SVG diagrams. Hover over the code block for a preview.
8585

86+
The examples below are rendered from `mermaid` code blocks in the markdown document from which this document is generated.
87+
88+
````
89+
```mermaid
90+
graph TD
91+
A[Buy Plant] --> B{Is it alive?}
92+
B -->|Yes| C[Water it]
93+
B -->|No| D[Try again]
94+
C --> E{Still alive?}
95+
E -->|Yes| C
96+
E -->|No| D
97+
```
98+
99+
```mermaid
100+
flowchart LR
101+
Sun --> Leaves --> Photosynthesis --> Growth
102+
Water --> Roots --> Growth
103+
```
104+
````
105+
106+
```mermaid
107+
graph TD
108+
A[Buy Plant] --> B{Is it alive?}
109+
B -->|Yes| C[Water it]
110+
B -->|No| D[Try again]
111+
C --> E{Still alive?}
112+
E -->|Yes| C
113+
E -->|No| D
114+
```
115+
116+
```mermaid
117+
flowchart LR
118+
Sun --> Leaves --> Photosynthesis --> Growth
119+
Water --> Roots --> Growth
120+
```
121+
86122
### Math / LaTeX
87123

88124
Inline math (`$...$`) and display math (`$$...$$`) are rendered using KaTeX/MathJax. Enable or disable via the `as-notes.inlineEditor.defaultBehaviors.math` setting.
89125

126+
The following code renders the math blocks below:
127+
128+
```
129+
Inline math: the growth rate is $G = k \cdot L \cdot W$ where $L$ is light and $W$ is water.
130+
131+
Display math block:
132+
133+
$$
134+
\frac{dP}{dt} = rP\left(1 - \frac{P}{K}\right)
135+
$$
136+
```
137+
138+
Inline math: the growth rate is $G = k \cdot L \cdot W$ where $L$ is light and $W$ is water.
139+
140+
Display math block:
141+
142+
$$
143+
\frac{dP}{dt} = rP\left(1 - \frac{P}{K}\right)
144+
$$
145+
90146
### GitHub Mentions and Issues
91147

92148
`@username` mentions and `#123` issue references are rendered with styled decorations. Enable or disable via the `as-notes.inlineEditor.defaultBehaviors.mentionLinks` setting.

0 commit comments

Comments
 (0)