liferay / electric

⚡ Create beautiful documentation for your projects
https://electricjs.com
Other
118 stars 26 forks source link

Add header anchor #126

Open zenorocha opened 6 years ago

zenorocha commented 6 years ago

metaljs.com has a nice little feature of having anchors on the headers.

screen recording 2018-03-02 at 07 47 pm

This was added manually on the markdown level:

## [Alias](#alias)

On GitHub's readme, they also offer that functionally, but their markdown renderer automatically adds an anchor with ID on the headers.

screen recording 2018-03-02 at 07 50 pm

We could research if Remarkable (our Markdown renderer) has that feature and add it to our markdownOptions settings.

justinsunho commented 6 years ago

Here are two threads related to this issue. It looks like the feature isn't built in, and you'd have to create a separate plugin to achieve this.

jonschlinkert/remarkable#122

jonschlinkert/remarkable#284