handlebars-lang / handlebars.js

Minimal templating on steroids.
http://handlebarsjs.com
MIT License
17.96k stars 2.04k forks source link

Broken Link on NPM Docs #1918

Closed rogadev closed 1 year ago

rogadev commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

@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 commented 1 year ago

@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 commented 1 year ago

@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 commented 1 year ago

@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? 👀