Skip to content

docs: description of automatic anchors for headers #75

Description

@loixou

Hi,

Is something unclear, missing or outdated in our documentation?

I used your plugin for my documentation, and I felt lonely to know the name of the automatic anchor.
Could you add a small description of rules for the name of references ?

For instance, I have two files:

- File 1
# My beautiful todo-list

- File 2
I want to make a reference to my subtitle [My beautiful todo-list][??????]

I believe an explaination of how the anchor is created (no capital letters, all spaces replaced by "-", ...) would be appreciated. (or at least redirect towards a common rule, if any).

Thanks a lot for your work!

Metadata

Metadata

Assignees

Labels

docsImprovements or additions to documentation

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions