yhatt / jsx-slack

Build JSON object for Slack Block Kit surfaces from JSX
https://jsx-slack.netlify.app/
MIT License
461 stars 15 forks source link

Make stable documentation anchor links #274

Closed yhatt closed 2 years ago

yhatt commented 2 years ago

Now GitHub is postprocessing Markdown anchor links to add prefix user-content- to each anchor. The documentation of jsx-slack is depending on the stable anchors defined by <a name="xxx" id="xxx"></a> and every links for external page have been broken. (Anchor links to the same page are still working)

So I've added user-content- prefix to all of anchor links that are referring to external pages in the jsx-slack reference.

In addition, every anchor definitions were updated to use the prefixed anchor in an obsoleted attribute name. The id attribute is keeping original anchor name. By making targetable with both anchors, we can make easy to move current documentation into the new site without broken links.