Skip to content

Commit

Permalink
chore: improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pengzhanbo committed Sep 15, 2024
1 parent 1ff4ed1 commit 2112f2b
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 16 deletions.
12 changes: 6 additions & 6 deletions docs/plugins/markdown/prismjs.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,14 +200,14 @@ export default defineUserConfig({

- Default: `'disabled'`

- Details: Whether to enable code block collapsing.
- Details: Default behavior of code block collapsing.

- `number`: collapse the code block starting from line `number`, for example, `12` means collapsing the code block starting from line 12.
- `true`: Equivalent to `15`, collapsing the code block starting from line 15.
- `false`: Disable code block collapsed, but `:collapsed-lines` can still be added to collapse individual code blocks.
- `'disabled'`: Completely disable code block collapsed, `:collapsed-lines` will not take effect.
- `number`: collapse the code block starting from line `number` by default, for example, `12` means collapsing the code block starting from line 12.
- `true`: Equivalent to `15`, collapsing the code block starting from line 15 by default.
- `false`: Add support for code block collapsing, but disable it globally
- `'disabled'`: Completely disable code block collapsing, `:collapsed-lines` will not take effect.

You can add the `:collapsed-lines` / `:no-collapsed-lines` marker to the code block to override the settings in the configuration item. You can also add `=` after `:collapsed-lines` to customize the starting collapsed line number, for example, `:collapsed-lines=12` means collapsing the code block starting from line 12.
To override global settings, you can add the `:collapsed-lines` / `:no-collapsed-lines` marker to the code block. You can also add `=` after `:collapsed-lines` to customize the starting line number being collapsed, for example, `:collapsed-lines=12` means collapsing the code block starting from line 12.

**Input:**

Expand Down
12 changes: 6 additions & 6 deletions docs/plugins/markdown/shiki.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,14 +196,14 @@ export default defineUserConfig({

- Default: `'disabled'`

- Details: Whether to enable code block collapsing.
- Details: Default behavior of code block collapsing.

- `number`: collapse the code block starting from line `number`, for example, `12` means collapsing the code block starting from line 12.
- `true`: Equivalent to `15`, collapsing the code block starting from line 15.
- `false`: Disable code block collapsed, but `:collapsed-lines` can still be added to collapse individual code blocks.
- `'disabled'`: Completely disable code block collapsed, `:collapsed-lines` will not take effect.
- `number`: collapse the code block starting from line `number` by default, for example, `12` means collapsing the code block starting from line 12.
- `true`: Equivalent to `15`, collapsing the code block starting from line 15 by default.
- `false`: Add support for code block collapsing, but disable it globally
- `'disabled'`: Completely disable code block collapsing, `:collapsed-lines` will not take effect.

You can add the `:collapsed-lines` / `:no-collapsed-lines` marker to the code block to override the settings in the configuration item. You can also add `=` after `:collapsed-lines` to customize the starting collapsed line number, for example, `:collapsed-lines=12` means collapsing the code block starting from line 12.
To override global settings, you can add the `:collapsed-lines` / `:no-collapsed-lines` marker to the code block. You can also add `=` after `:collapsed-lines` to customize the starting line number being collapsed, for example, `:collapsed-lines=12` means collapsing the code block starting from line 12.

**Input:**

Expand Down
4 changes: 2 additions & 2 deletions docs/zh/plugins/markdown/prismjs.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,11 +200,11 @@ export default defineUserConfig({

- 默认值:`'disabled`

- 详情:是否启用代码块折叠
- 详情:代码块折叠的默认行为

- `number`: 从第 `number` 行开始折叠代码块,例如,`12` 表示从第 12 行开始折叠代码块。
- `true`: 等同于 `15`, 从第 15 行开始折叠代码块。
- `false`: 不启用代码块折叠,但仍然可以添加 `:collapsed-lines` 标记为单个代码块折叠
- `false`: 添加代码块折叠支持,但全局禁用此功能
- `'disabled'`: 完全禁用代码块折叠, `:collapsed-lines` 标记不会生效。

你可以在代码块添加 `:collapsed-lines` / `:no-collapsed-lines` 标记来覆盖配置项中的设置。还可以在 `:collapsed-lines` 之后添加 `=` 来自定义起始折叠行号,例如 `:collapsed-lines=12` 表示代码块从第 12 行开始折叠。
Expand Down
4 changes: 2 additions & 2 deletions docs/zh/plugins/markdown/shiki.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,11 +198,11 @@ export default defineUserConfig({

- 默认值:`'disabled'`

- 详情:是否启用代码块折叠
- 详情:代码块折叠的默认行为

- `number`: 从第 `number` 行开始折叠代码块,例如,`12` 表示从第 12 行开始折叠代码块。
- `true`: 等同于 `15`, 从第 15 行开始折叠代码块。
- `false`: 不启用代码块折叠,但仍然可以添加 `:collapsed-lines` 标记为单个代码块折叠。
- `false`: 添加代码块折叠支持,但全局禁用此功能
- `'disabled'`: 完全禁用代码块折叠, `:collapsed-lines` 标记不会生效。

你可以在代码块添加 `:collapsed-lines` / `:no-collapsed-lines` 标记来覆盖配置项中的设置。还可以在 `:collapsed-lines` 之后添加 `=` 来自定义起始折叠行号,例如 `:collapsed-lines=12` 表示代码块从第 12 行开始折叠。
Expand Down

0 comments on commit 2112f2b

Please sign in to comment.