Skip to content

Commit c4116a5

Browse files
committed
docs: update
1 parent e5f827f commit c4116a5

2 files changed

Lines changed: 13 additions & 2 deletions

File tree

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,12 @@ All frontmatter options are optional.
5858
- **`markmap`** : Correspond to the [`IMarkmapJSONOptions`](https://markmap.js.org/api/interfaces/markmap-view.IMarkmapJSONOptions.html) in the markmap project. For more details, please refer to [`jsonOptions`](https://markmap.js.org/docs/json-options#option-list).
5959
- alias: **`options`** (for backward compatibility)
6060

61+
62+
<details>
63+
64+
<summary>Difference between `markmap` and `options`</summary>
65+
6166
> [!TIP]
62-
> **Difference between `markmap` and `options`**
6367
>
6468
> - **`markmap` (from markmap-lib)**
6569
> Will be [preprocessed](https://github.com/markmap/markmap/blob/master/packages/markmap-lib/src/plugins/frontmatter/index.ts#L41) (e.g., converting strings to arrays or numbers) and overrides the legacy `options`.
@@ -69,6 +73,8 @@ All frontmatter options are optional.
6973
> - **`options` (from markmap-universe)** Passed directly to markmap-view.
7074
> - ❌ Not recommended, maintained only for backward compatibility.
7175
76+
</details>
77+
7278

7379
#### Tag Options
7480

README.zh.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,11 @@ markmap:
5656
- **`markmap`**/**`options`**:对应 markmap 项目中的 [`IMarkmapJSONOptions`](https://markmap.js.org/api/interfaces/markmap-view.IMarkmapJSONOptions.html)。有关更多详细信息,请参考 [`jsonOptions`](https://markmap.js.org/docs/json-options#option-list)
5757
- 别名:**`options`**(向后兼容)
5858

59+
<details>
60+
61+
<summary>`markmap` 和 `options` 的区别</summary>
62+
5963
> [!TIP]
60-
> **`markmap``options` 的区别**
6164
>
6265
> - **`markmap`(来自 markmap-lib)**
6366
> JSON Options 会被[预处理](https://github.com/markmap/markmap/blob/master/packages/markmap-lib/src/plugins/frontmatter/index.ts#L41)(例如,将字符串转换为数组或数字),并优先覆盖 `options`
@@ -68,6 +71,8 @@ markmap:
6871
> - ❌ 不推荐使用,仅为向后兼容而保留。
6972
>
7073
74+
</details>
75+
7176
#### 标签选项
7277

7378
你还可以直接在标签中指定思维导图的高度,默认情况下会根据内容进行计算。

0 commit comments

Comments
 (0)