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

Refs: a1b31decd4
This commit is contained in:
dragonish 2025-04-02 22:05:24 +08:00
parent a1b31decd4
commit 1900c6ba4f
No known key found for this signature in database
GPG key ID: 6F42FA9E807A5177
4 changed files with 8 additions and 0 deletions

View file

@ -74,6 +74,14 @@ For the *Ignore the single heading at the top-level* setting, if the top-level h
| :-----: | :----------------------------------------: |
| ![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) |
#### Allow zero level
For the *Allow zero level* setting, if the next heading is more than one level higher, the omitted level is zero instead of one. For example:

BIN
images/ignore-default.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

BIN
images/no-ignore.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB