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

Fixes anchor tags for NPM #1071

Closed
wants to merge 1 commit into from
Closed

Conversation

schalkventer
Copy link

<a src="#*"> are not supported on NPM, it might be better to just use the automatically generated anchor IDs since this means the table of contents will work on both Github and NPM

For example https://www.npmjs.com/package/microbundle#formats does not work, but https://www.npmjs.com/package/microbundle#-output-formats- works.

`<a src="#*">` are not supported on NPM, it might be better to just use the automatically generated anchor IDs since this means the table of contents will work on both Github and NPM
Copy link

changeset-bot bot commented Jan 5, 2024

⚠️ No Changeset found

Latest commit: 561ac84

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

<a href="#modern">Modern Mode</a> ✯
<a href="#usage">Usage &amp; Configuration</a> ✯
<a href="#options">All Options</a>
<a href="#-installation--setup--">Setup</a> ✯
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't appear to work on GitHub though

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting, it works on my side (see screenshot).

image

Curious why this might be the case on your side?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me spin up a local version of the repo and preview the markdown in VS Code and see whether that changes it.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GitHub's markdown renderer is notoriously inconsistent cross-platform, but this doesn't work for me on Windows Chrome & FF, Linux FF, or iOS Safari.

Test on the readme of your fork, does this link actually work? https://github.com/schalkventer/microbundle/tree/patch-1#-installation--setup--

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't find a single environment in which those trailing -'s are present -- what's your system details? Where are you running this where that gets generated?

@rschristian rschristian closed this Jun 4, 2024
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

Successfully merging this pull request may close these issues.

None yet

2 participants