Skip to content

Commit e4ef658

Browse files
Merge pull request #14 from markbattistella/2024.07.10
2024-06-12 - Doc fixes
2 parents 57bf343 + a9fb82c commit e4ef658

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
</div>
66

7-
This plugin enhances your Docsify documentation by automatically generating numbered headers for your markdown files. It allows you to configure the header levels, numbering format, and inclusion in the sidebar. By utilizing this plugin, you can easily manage and navigate through your documentation headers, ensuring consistency and improved readability.
7+
This plugin enhances your Docsify documentation by automatically generating numbered headers for your markdown files. It allows you to configure the header levels, numbering format, and inclusion in the sidebar. By utilising this plugin, you can easily manage and navigate through your documentation headers, ensuring consistency and improved readability.
88

99
## Demo pages
1010

@@ -77,6 +77,20 @@ There are several options available for the docsify-auto-headers plugin:
7777

7878
The plugin can be configured to apply scoped heading counts in either the sidebar or the main content, depending on your setup.
7979

80+
### Adding the signifier
81+
82+
When you want to use the heading numbering on a markdown file you can add either of the following signifiers to the **first line** of the document:
83+
84+
```md
85+
@autoHeader:
86+
```
87+
88+
```md
89+
<!-- autoHeader: -->
90+
```
91+
92+
After the colon (`:`) you can add in the number that will begin for heading level 1 (`H1`).
93+
8094
### Sidebar
8195

8296
If the `sidebar` option is enabled, the headers will be included in the sidebar and processed before rendering the markdown.

0 commit comments

Comments
 (0)