OAI / OpenAPI-Specification

The OpenAPI Specification Repository
https://openapis.org
Apache License 2.0
28.97k stars 9.07k forks source link

Anchor Links in the spec do not work anymore #1726

Closed cebe closed 5 years ago

cebe commented 6 years ago

Seems github filters the <a name="..."> tags...

MikeRalphson commented 6 years ago

Thanks for the report. We're looking into it.

cebe commented 6 years ago

As I am very sure that this has been working fine before it might be worth contacting github support and ask to revert the change or otherwise fix it.

Gi60s commented 6 years ago

It's not all links, just any links that have multiple words. For example:

Works: #schema Does not work: #infoObject

One way to fix is to update the multi-word links to use dashes instead of camel case. For example, convert #infoObject to #info-object and links will start working again.

I'm not sure why Github ever supported camel case links. I've haven't seen another markdown to HTML converter support that.

MikeRalphson commented 6 years ago

Yes, it looks like we may have been relying on some very old compatibility behaviour.

cebe commented 6 years ago

With dashes are the links that are automatically generated by github. camelCase are anchors added in the spec markdown. If you render the spec outside of github links would be working. The filtering done here is specific to github.

MikeRalphson commented 6 years ago

Also affects READMEs, reported on #1734

cebe commented 6 years ago

I have contacted github support about this. Will post here when I have an answer.

cebe commented 5 years ago

Looks like they fixed it. It's working again for me. Close the issue if you confirm.

MikeRalphson commented 5 years ago

Thanks @cebe I'm still seeing the problem, but it may be a cacheing issue.

Gi60s commented 5 years ago

It doesn't work for me yet. Tried on two browsers and even disabled cache.

ramsey commented 5 years ago

It's still not working for me. Maybe it's cached at an edge location somewhere?

shockey commented 5 years ago

Still broken for me - I did the browser/cache dance as well 😕

webron commented 5 years ago

I'm also in touch with GitHub's support about it, will update when I know more.

cebe commented 5 years ago

Got a reply from github support today:

Hey Carsten,

Our Engineering Team shipped a fix for those anchor links.

Please let us know if you have any further trouble with it. [...]

webron commented 5 years ago

Thanks, @cebe - got the same reply. Let the anchor-following resume!