@markbattistella/docsify-autoheaders 5.0.1 → 5.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -3
- package/README.md +18 -4
- package/dist/docsify-auto-headers.js +610 -576
- package/dist/docsify-auto-headers.min.js +1 -2
- package/package.json +10 -10
package/CHANGELOG.md
CHANGED
|
@@ -1,11 +1,14 @@
|
|
|
1
|
+
## 5.1.0 - 2025-09-04
|
|
1
2
|
|
|
2
|
-
|
|
3
|
+
- If you are using Front Matter you can use `autoHeader: xx` in there instead of needing the signifier to be the first line
|
|
4
|
+
|
|
5
|
+
## 5.0.1 - 2024-06-11
|
|
3
6
|
|
|
4
7
|
### Fixed
|
|
5
8
|
|
|
6
9
|
- Documentation fixes.
|
|
7
10
|
|
|
8
|
-
## 5.0.0 -
|
|
11
|
+
## 5.0.0 - 2024-06-11
|
|
9
12
|
|
|
10
13
|
### Breaking Changes
|
|
11
14
|
|
|
@@ -15,4 +18,4 @@
|
|
|
15
18
|
- Allows numbering in sidebar and main body
|
|
16
19
|
- Better handling of debugging
|
|
17
20
|
- Numbering can use letters and not just numbers
|
|
18
|
-
- Many more
|
|
21
|
+
- Many more features and cleanups
|
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
</div>
|
|
6
6
|
|
|
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
|
|
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.
|
|
8
8
|
|
|
9
9
|
## Demo pages
|
|
10
10
|
|
|
@@ -28,13 +28,13 @@ Assuming you have a working [docsify](https://docsify.js.org/) framework set up,
|
|
|
28
28
|
|
|
29
29
|
```html
|
|
30
30
|
<!-- unpkg.com -->
|
|
31
|
-
<script src="https://unpkg.com/@markbattistella/docsify-
|
|
31
|
+
<script src="https://unpkg.com/@markbattistella/docsify-autoheaders@latest"></script>
|
|
32
32
|
|
|
33
33
|
<!-- jsDelivr -->
|
|
34
|
-
<script src="https://cdn.jsdelivr.net/npm/@markbattistella/docsify-
|
|
34
|
+
<script src="https://cdn.jsdelivr.net/npm/@markbattistella/docsify-autoheaders@latest"></script>
|
|
35
35
|
|
|
36
36
|
<!-- locally -->
|
|
37
|
-
<script src="docsify-
|
|
37
|
+
<script src="docsify-autoheaders.min.js"></script>
|
|
38
38
|
```
|
|
39
39
|
|
|
40
40
|
1. In docsify setup, configure the plugin:
|
|
@@ -77,6 +77,20 @@ There are several options available for the docsify-auto-headers plugin:
|
|
|
77
77
|
|
|
78
78
|
The plugin can be configured to apply scoped heading counts in either the sidebar or the main content, depending on your setup.
|
|
79
79
|
|
|
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
|
+
|
|
80
94
|
### Sidebar
|
|
81
95
|
|
|
82
96
|
If the `sidebar` option is enabled, the headers will be included in the sidebar and processed before rendering the markdown.
|