Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make stable documentation anchor links #274

Merged
merged 3 commits into from
Jul 16, 2022
Merged

Make stable documentation anchor links #274

merged 3 commits into from
Jul 16, 2022

Conversation

yhatt
Copy link
Owner

@yhatt yhatt commented Jul 16, 2022

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.

@yhatt yhatt changed the title Make stable anchor links to the external reference page Make stable documentation anchor links Jul 16, 2022
@yhatt yhatt merged commit 609c12f into main Jul 16, 2022
@yhatt yhatt deleted the improved-docs-link branch July 16, 2022 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant