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

Jump to bottom

Broken Link on NPM Docs #1918

Open
rogadev opened this issue Feb 1, 2023 · 5 comments
Open

Broken Link on NPM Docs #1918

rogadev opened this issue Feb 1, 2023 · 5 comments

Comments

@rogadev
Copy link

rogadev commented Feb 1, 2023

If you navigate to the npm docs for handlebars you'll notice that the first link under "Usage" to the Mustache Man website is broken.

"Usage
In general, the syntax of Handlebars.js templates is a superset of Mustache templates. For basic syntax, check out the Mustache manpage."

The link used is:
http://mustache.github.com/mustache.5.html

What it should be is:
http://mustache.github.io/mustache.5.html

I'm not sure if I could have made the edit myself directly. I didn't see the same issue in your GitHub readme. So I assume it's pulling from a different readme file. Hope this helps!
@jaylinski
Copy link
Member

jaylinski commented Feb 2, 2023 •
edited

This was already fixed in our master-branch, but not yet released as new npm-package-version.

We should probably backport those fixes to the 4.x branch and release a new version.

@rogadev
Copy link
Author

rogadev commented Feb 2, 2023

@jaylinski For my own future reference, where do the docs live that would reflect a change to the npm documentation? And is that where most people save them? I've never uploaded my own npm package before so I'm not familiar with the process.

@jaylinski
Copy link
Member

@rogadev npmjs.com simply displays the README.md file. Or more specifically, the file defined here:
https://github.com/handlebars-lang/handlebars.js/blob/v4.7.7/package.json#L19

@rogadev
Copy link
Author

rogadev commented Feb 6, 2023

@rogadev npmjs.com simply displays the README.md file. Or more specifically, the file defined here: https://github.com/handlebars-lang/handlebars.js/blob/v4.7.7/package.json#L19

Oh, interesting. Because the README in this repo on the main branch (master) links to the correct URL, but the NPM documentation links to the wrong one. 🤔

@eerison
Copy link

eerison commented Mar 29, 2023

@rogadev npmjs.com simply displays the README.md file. Or more specifically, the file defined here: https://github.com/handlebars-lang/handlebars.js/blob/v4.7.7/package.json#L19

if it was fixed in version 4.7.7, then I guess this issue could be closed? 👀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@jaylinski @eerison @rogadev