search

microsoft / vsmarketplace

Customer feedback and issue tracker repository for Visual Studio Marketplace
MIT License
40 stars 10 forks source link

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

Open igorskyflyer opened 3 months ago

igorskyflyer commented 3 months ago

Describe the bug From https://github.com/microsoft/vscode/issues/224644#issue-2445774681

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
Neelima10735584 commented 3 months ago

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