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

Add a description of the "Allow zero level" setting.

Refs: fb63af97d1
This commit is contained in:
dragonish 2025-03-13 10:32:59 +08:00
parent 20d2477c24
commit 30b1f9cc87
No known key found for this signature in database
GPG key ID: 6F42FA9E807A5177
3 changed files with 7 additions and 1 deletions

View file

@ -46,10 +46,16 @@ You can control the counter style type and delimiter. There are two special type
![Specified String](images/specified-string.jpg)
In addition, for the *Ignore the single heading at the top-level* setting item, if the top-level has only a single heading, exclude it when building an unordered list. For example:
In addition, 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 unordered list. For example:
![Ignore the single heading at the top-level](images/ignore-single-heading.jpg)
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:
| Default | Allow zero level |
| :-----: | :--------------: |
| ![omitted](images/omitted.jpg) | ![zero level](images/zero.jpg) |
### Unordered
Directly decorate the heading according to the level. For example, using `H1 H2 H3 H4 H5 H6`:

BIN
images/omitted.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

BIN
images/zero.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB