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

Links to markdown anchors with parenthesis not working #62

Closed
mnich0ls opened this issue Dec 17, 2021 · 2 comments
Closed

Links to markdown anchors with parenthesis not working #62

mnich0ls opened this issue Dec 17, 2021 · 2 comments

Comments

@mnich0ls
Copy link
Contributor

The links generated at the top of a markdown document that link to each request and request example, don't seem to format the header ID the same way markdown converters do. e.g. they do not strip out parenthesis or "="

My Header (var=true)

My Header (var=true)

I've tested the generated markdown in Gitlab and a markdown plugin for Chrome and see the same results. I'm not sure if Github generates anchor IDs differently (I added the example above to check). Here's the Gitlab documentation showing how IDs for headers with parenthesis are generated: https://docs.gitlab.com/ee/user/markdown.html#header-ids-and-links

mnich0ls added a commit to mnich0ls/docgen that referenced this issue Dec 18, 2021
…hedevsaddam#62

Removes any non word or digit (excluding hyphens "-") from links
to anchors in markdown document
thedevsaddam added a commit that referenced this issue Dec 21, 2021
Fix links to markdown anchors; Resolve issue #62
@thedevsaddam
Copy link
Owner

@mnich0ls Thanks for fixing the issue 👍

@mnich0ls
Copy link
Contributor Author

No problem. Thanks for merging.

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