Skip to content

Commit d3a6179

Browse files
committed
deploy: e61621c
1 parent 1f76ae9 commit d3a6179

File tree

3 files changed

+88
-25
lines changed

3 files changed

+88
-25
lines changed

docs/README.md

+59
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
- 创建一个 `<div id="app"></div>` 元素
77
- 引入 `jian-doc.umd.js`
88

9+
可以从此处获取:[jian-doc.umd.js](https://ifyun.github.io/jian-doc/jian-doc.umd.js)
10+
911
```html
1012
<!doctype html>
1113
<html lang="en">
@@ -102,6 +104,19 @@
102104
<script src="https://unpkg.com/katex@0.16.9/dist/katex.min.js"></script>
103105
```
104106

107+
### 图表
108+
109+
引入 `mermaid`,挂载到 `window` 对象:
110+
111+
```html
112+
<script type="module">
113+
import mermaid from "https://unpkg.com/mermaid@10/dist/mermaid.esm.min.mjs"
114+
window.mermaid = mermaid
115+
</script>
116+
```
117+
118+
代码块语言为 `mermaid` 即可编写图表。
119+
105120
## 文档样式测试
106121

107122
### 段落
@@ -144,3 +159,47 @@ A_{m,n} =
144159
a_{m,1} & a_{m,2} & \cdots & a_{m,n}
145160
\end{pmatrix}
146161
$$
162+
163+
### Mermaid
164+
165+
序列图:
166+
167+
```mermaid
168+
sequenceDiagram
169+
participant C as Client
170+
participant S as Server
171+
172+
Note right of S: LISTEN
173+
C ->> S : SYN = 1, seq = x
174+
Note left of C: SYN_SENT
175+
S ->> C : SYN = 1, ACK = 1, seq = y, ack = x + 1
176+
Note right of S: SYN_RECV
177+
C ->> S : ACK = 1, seq = x + 1, ack = y + 1
178+
Note left of C: ESTABLISHED
179+
Note right of S: ESTABLISHED
180+
```
181+
182+
状态图:
183+
184+
```mermaid
185+
stateDiagram-v2
186+
[*] --> NEW
187+
NEW --> RUNNABLE: Thread.start()
188+
189+
state RUNNABLE {
190+
RUNNING --> READY
191+
READY --> RUNNING
192+
}
193+
194+
RUNNABLE --> BLOCKED: 未获取到锁
195+
BLOCKED --> RUNNABLE: 获取到锁
196+
197+
RUNNABLE --> TIMED_WAITING: Thread.sleep(long)\nObject.wait(long)
198+
TIMED_WAITING --> RUNNABLE: Object.notify()
199+
200+
RUNNABLE --> WAITING: Thread.join()
201+
WAITING --> RUNNABLE: Object.notify()
202+
203+
RUNNABLE --> TERMINATED: 执行完成
204+
TERMINATED --> [*]
205+
```

index.html

+4
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@
1313
rel="stylesheet"
1414
href="https://unpkg.com/katex@0.16.9/dist/katex.min.css" />
1515
<script src="https://unpkg.com/katex@0.16.9/dist/katex.min.js"></script>
16+
<script type="module">
17+
import mermaid from "https://unpkg.com/mermaid@10/dist/mermaid.esm.min.mjs"
18+
window.mermaid = mermaid
19+
</script>
1620
<script>
1721
window.$config = {
1822
prefix: "docs",

jian-doc.umd.js

+25-25
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)