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

Anchor link is reported as broken even though it's not broken #2

Open
amimas opened this issue Jun 12, 2019 · 3 comments
Open

Anchor link is reported as broken even though it's not broken #2

amimas opened this issue Jun 12, 2019 · 3 comments

Comments

@amimas
Copy link

amimas commented Jun 12, 2019

I have a heading with a special character (apostrophe) like this:

## Connecting to Application’s JVM

Some content goes here

I have a relative link to the above section that works in my rendering tool. The anchor link is written as:

For more information, see [Connecting to the Applications JVM’s](#connecting-to-application-s-jvm)

The above line is reported as containing broken anchor link even though it's not broken.

@parthpp
Copy link
Contributor

parthpp commented Jun 13, 2019

The root cause to this problem is that an internal dependency of this rule i.e GitHub-slugger does not recognize apostrophe in it's special characters. Thus, the slugger generates header as 'connecting-to-applications-jvm'. I will try to get this fixed in gitHub-slugger and that should subsequently fix this issue as well.

@parthpp
Copy link
Contributor

parthpp commented Jun 24, 2019

This issue triggered fixes in 2 projects

  1. github-slugger - The PR is awaiting to be merged here
  2. Docusaurus - The fix has been merged with PR-1618 and it should be available in npm with next release of Docusaurus.
    I will close this issue once the PR on github-slugger is merged.

@amimas
Copy link
Author

amimas commented Sep 19, 2019

@parthpp - Do you know if this is issue is resolved already?

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

No branches or pull requests

2 participants