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

Wrong auto-links in an extension's README #983

Open
igorskyflyer opened this issue Aug 11, 2024 · 1 comment
Open

Wrong auto-links in an extension's README #983

igorskyflyer opened this issue Aug 11, 2024 · 1 comment
Labels
bug Something isn't working triaged

Comments

@igorskyflyer
Copy link

Describe the bug
From
microsoft/vscode#224644 (comment)

Both VS Code and GitHub use a GitHub-flavored Markdown engine and auto-create jumpable/anchor links in both VS Code and GitHub (using the HTML id attribute) when using headings. If there are non-supported characters they are replaced with a hyphen - (and lower-cased but not relevant here), e.g.:

🤖 Features -> #-features

which works fine, in both GitHub and VS Code (example repository) but fails on the Marketplace, which as mentioned in the official documentation [see markdown field] uses the same GitHub-flavored Markdown but the links stop working (example extension) because it does NOT replace the non-supported characters with a hyphen -, it strips them completely, rendering jumpable links broken on the Marketplace.


Upon inspection of the extension's page, we can clearly see that the id does not comply with the GitHub-flavored anchor links rendering.

Marketplace source code

Marketplace HTML source code


Steps to Reproduce:

  1. Go to this GitHub repository
  2. Click on any link in the Table of Contents
  3. The browser will jump to the correct section
  4. Go to this VS Code extension page
  5. Click on any link in the Table of Contents
  6. The browser will NOT jump to the correct section
@igorskyflyer igorskyflyer added the bug Something isn't working label Aug 11, 2024
@Neelima10735584
Copy link

Hi @igorskyflyer,

Thank you for reaching VS Marketplace Team. We are following up to determine how best to address it.

Regards,
VS Marketplace Support Team

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working triaged
Projects
None yet
Development

No branches or pull requests

3 participants