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

Support for links on npm #63

Closed
brettz9 opened this issue Dec 29, 2021 · 2 comments · Fixed by #64
Closed

Support for links on npm #63

brettz9 opened this issue Dec 29, 2021 · 2 comments · Fixed by #64

Comments

@brettz9
Copy link
Contributor

brettz9 commented Dec 29, 2021

In making a document which also works on npmjs.com, we need support for links which are prefixed with user-content-. GitHub supports this prefix in addition to unprefixed ones, while npmjs.com requires it.

For example with eslint-plugin-jsdoc, the Markdown Settings heading gets turned into the anchor user-content-settings, and the HTML anchor eslint-plugin-jsdoc-settings becomes user-content-eslint-plugin-jsdoc-settings with no other anchors available.

I'm guessing the article ID passed on to your contents generators may need to be prefixed with user-content-.

This would fix our gajus/eslint-plugin-jsdoc#707

@gajus
Copy link
Owner

gajus commented Jan 3, 2022

Seems like a reasonable fix. If you are available to contribute, would quickly release it.

@brettz9 brettz9 mentioned this issue Jan 4, 2022
@gajus gajus closed this as completed in #64 Mar 1, 2022
@gajus
Copy link
Owner

gajus commented Mar 1, 2022

🎉 This issue has been resolved in version 3.1.5 🎉

The release is available on:

Your semantic-release bot 📦🚀

@gajus gajus added the released label Mar 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants