Skip to content

Commit

Permalink
Add missing heading id opts to README
Browse files Browse the repository at this point in the history
  • Loading branch information
MattIPv4 committed Apr 18, 2023
1 parent 6046f8d commit e47e3e4
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Any non-code changes should be prefixed with `(docs)`.
See `PUBLISH.md` for instructions on how to publish a new version.
-->

- (docs) Fix README heading ordering
- (docs) Fix README heading ordering, add missing heading_id opts
- (minor) Hash link position, heading link + clipboard settings


Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1098,6 +1098,9 @@ Set this property to `false` to disable this plugin.
- `hashLink` Set this property to `false` to disable this feature.
- `maxLevel` (`number`, optional, defaults to `3`): Max heading level to generate hash links for.
- `class` (`string`, optional, defaults to `hash-anchor`): Class name to use on the anchor tag.
- `position` (`'before'|'after'`, optional, defaults to `before`): Position of the anchor tag relative to the heading.
- `linkHeading` (`boolean`, optional, defaults to `true`): Whether to link the heading text to the hash link.
- `clipboard` (`boolean`, optional, defaults to `true`): Whether to write the hash link to the clipboard on click.
</details>

### image_settings
Expand Down

0 comments on commit e47e3e4

Please sign in to comment.