Skip to content

Commit

Permalink
Merge pull request #14 from markbattistella/2024.07.10
Browse files Browse the repository at this point in the history
2024-06-12 - Doc fixes
  • Loading branch information
markbattistella authored Jul 10, 2024
2 parents 57bf343 + a9fb82c commit e4ef658
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

</div>

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.
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.

## Demo pages

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

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

### Adding the signifier

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:

```md
@autoHeader:
```

```md
<!-- autoHeader: -->
```

After the colon (`:`) you can add in the number that will begin for heading level 1 (`H1`).

### Sidebar

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

0 comments on commit e4ef658

Please sign in to comment.