docs(readme): add a description for the new setting

Refs: f640b8e515
This commit is contained in:
dragonish 2025-06-20 21:32:24 +08:00
parent 5aaa0605e5
commit cc463bae79
No known key found for this signature in database
GPG key ID: 6F42FA9E807A5177
7 changed files with 36 additions and 36 deletions

View file

@ -82,21 +82,21 @@
| :--: | :------------: |
| ![默认](images/heading-2.jpg) | ![基于现有的最高级别](images/based-on-existing.jpg) |
#### 始终忽略顶层的标题
在构建有序列表时将顶层的标题排除掉,受*忽略的最大层级数量*选项控制。例如:
| 默认 | 始终忽略顶层的标题 (忽略的最大层级数量为 `2`) |
| :--: | :----------------------------------:|
| ![默认](images/default.jpg) | ![始终忽略顶层的标题](images/always.jpg) |
#### 忽略顶层的独立标题
对于*忽略顶层的独立标题*设置,如果顶层只有一个标题,则在构建有序列表时将其排除。此设置包含*基于现有的最高级别*,但它处理得更为“激进”。例如:
对于*忽略顶层的独立标题*设置,如果顶层只有一个标题,则在构建有序列表时将其排除,受*忽略的最大层级数量*选项控制。此设置包含*基于现有的最高级别*,但它处理得更为“激进”。例如:
| 默认 | 忽略顶层的独立标题 |
| :--: | :------------: |
| ![默认](images/default.jpg) | ![忽略顶层的独立标题](images/ignore-single-heading.jpg) |
##### 忽略的最大数量
对于已启用:忽略顶层的独立标题。顶层可忽略标题的最大数量。例如:
| 默认 | 忽略顶层的独立标题,使用默认值(`6`) | 忽略的最大数量为 `1` |
| :--: | :--------------------------: | :---------------: |
| ![默认](images/no-ignore.jpg) | ![忽略顶层的独立标题](images/ignore-default.jpg) | ![忽略的最大数量](images/ignore-with-number-1.jpg) |
| 默认 | 忽略顶层的独立标题 (忽略的最大层级数量为 `1`) | 忽略顶层的独立标题 (忽略的最大层级数量为 `6`) |
| :--: | :-----------------------------------: | :-----------------------------------: |
| ![默认](images/no-ignore.jpg) | ![忽略顶层的独立标题 1](images/ignore-with-number-1.jpg) | ![忽略顶层的独立标题 6](images/ignore-with-number-6.jpg) |
### 无序列表

View file

@ -82,21 +82,21 @@
| :--: | :------------: |
| ![預設](images/heading-2.jpg) | ![基於現有的最高級別](images/based-on-existing.jpg) |
#### 始終忽略頂層的標題
在構建有序列表時將頂層的標題排除掉,受*忽略的最大層級數量*選項控制。例如:
| 預設 | 始終忽略頂層的標題 (忽略的最大層級數量為 `2`) |
| :--: | :------------------------------------:|
| ![預設](images/default.jpg) | ![始終忽略頂層的標題](images/always.jpg) |
#### 忽略頂層的獨立標題
對於*忽略頂層的獨立標題*設定,如果頂層只有一個標題,則在構建有序列表時將其排除。此設定包含*基於現有的最高級別*,但它處理得更為“激進”。例如:
對於*忽略頂層的獨立標題*設定,如果頂層只有一個標題,則在構建有序列表時將其排除,受*忽略的最大層級數量*選項控制。此設定包含*基於現有的最高級別*,但它處理得更為“激進”。例如:
| 預設 | 忽略頂層的獨立標題 |
| :--: | :------------: |
| ![預設](images/default.jpg) | ![忽略頂層的獨立標題](images/ignore-single-heading.jpg) |
##### 忽略的最大數量
對於已啟用:忽略頂層的獨立標題。頂層可忽略標題的最大數量。例如:
| 預設 | 忽略頂層的獨立標題,使用預設值(`6`) | 忽略的最大數量為 `1` |
| :--: | :--------------------------: | :---------------: |
| ![預設](images/no-ignore.jpg) | ![忽略頂層的獨立標題](images/ignore-default.jpg) | ![忽略的最大數量](images/ignore-with-number-1.jpg) |
| 預設 | 忽略頂層的獨立標題 (忽略的最大層級數量為 `1`) | 忽略頂層的獨立標題 (忽略的最大層級數量為 `6`) |
| :--: | :-----------------------------------: | :-----------------------------------: |
| ![預設](images/no-ignore.jpg) | ![忽略頂層的獨立標題 1](images/ignore-with-number-1.jpg) | ![忽略頂層的獨立標題 6](images/ignore-with-number-6.jpg) |
### 無序列表

View file

@ -84,21 +84,21 @@ For the *Based on the existing highest level* setting, use the highest level of
| :-----: | :----------------------------------: |
| ![Default](images/heading-2.jpg) | ![Based on the existing highest level](images/based-on-existing.jpg) |
#### Always ignore the top-level headings
Exclude the top-level heading when building ordered lists. controlled by the *Maximum number of ignored levels* option. For example:
| Default | Always ignore the top-level headings (Maximum number of ignored levels set to `2`) |
| :-----: | :---------------------------------------------------------------------------------:|
| ![Default](images/default.jpg) | ![Always ignore the top-level headings](images/always.jpg) |
#### Ignore the single heading at the top-level
For the *Ignore the single heading at the top-level* setting, if the top-level has only a single heading, exclude it when building an ordered list. This setting contains *Based on the existing highest level*, but it deals with more "aggressive". For example:
For the *Ignore the single heading at the top-level* setting, if the top-level has only a single heading, exclude it when building an ordered list. controlled by the *Maximum number of ignored levels* option. This setting contains *Based on the existing highest level*, but it deals with more "aggressive". For example:
| Default | Ignore the single heading at the top-level |
| :-----: | :----------------------------------------: |
| ![Default](images/default.jpg) | ![Ignore the single heading at the top-level](images/ignore-single-heading.jpg) |
##### The maximum number of ignored
For enabled: Ignore the single heading at the top-level. The maximum number of ignored headings at the top-level. For example:
| Default | Ignore the single heading at the top-level with default value (`6`) | The maximum number of ignored is `1` |
| :-----: | :-----------------------------------------------------------------: | :----------------------------------: |
| ![Default](images/no-ignore.jpg) | ![Ignore the single heading at the top-level](images/ignore-default.jpg) | ![The maximum number of ignored is 1](images/ignore-with-number-1.jpg) |
| Default | Ignore the single heading at the top-level (Maximum number of ignored levels set to `1`) | Ignore the single heading at the top-level (Maximum number of ignored levels set to `6`) |
| :-----: | :-----------------------------------------------------------------: | :-----------------------------------------------------------------------------: |
| ![Default](images/no-ignore.jpg) | ![Ignore the single heading at the top-level](images/ignore-with-number-1.jpg) | ![The maximum number of ignored is 1](images/ignore-with-number-6.jpg) |
### Unordered

BIN
images/always.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 78 KiB

After

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 74 KiB

View file

Before

Width:  |  Height:  |  Size: 64 KiB

After

Width:  |  Height:  |  Size: 64 KiB