-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
https://marked.js.org/ has confusing links #1167
Comments
@UziTech Correct. The reason why the html files exist is because GitHub Pages builds the docs with jekyll on each push to this folder (on the master branch). It's a convenience feature that we don't really need because we are using marked to render the Which part is confusing about the links? |
Confusing is that the main rendered HTML page refers to the |
For example, in this sentence:
both links refer to unrendered |
Ok thanks 👍 I see two points of confusion:
Did that describe your problem? |
Oh, I did not even know that I can navigate inside a page. I usually open links in a new tab. Yes, and maybe: |
And if a reader mixes #hash navigation with re-render trick navigation the history navigation becomes very confusing. |
Some links in https://marked.js.org/ refer to
.md
files. This may be confusing and the files are hardly readable.Some of these links have their
.html
counterparts on the site, some have not.https://marked.js.org/USING_ADVANCED.md
(https://marked.js.org/USING_ADVANCED.html exists)
https://marked.js.org/USING_PRO.md
(https://marked.js.org/USING_PRO.html exists)
https://marked.js.org/AUTHORS.md
(https://marked.js.org/AUTHORS.html exists)
https://marked.js.org/CONTRIBUTING.md
(https://marked.js.org/CONTRIBUTING.html is 404)
The text was updated successfully, but these errors were encountered: