Hash change docs #1168
Hash change docs #1168
Conversation
|
This seems to work with linking to specific sections of a 😃 👍 |
docs/index.html
Outdated
| if(currentHash) { | ||
| var hashElement = document.getElementById(currentHash); | ||
| if (hashElement) { | ||
| hashElement.scrollIntoView(); |
There was a problem hiding this comment.
Change hashElement.scrollIntoView(); to hashElement.scrollIntoView({ behavior: 'smooth' }); for a buttery transition ⛷️
There was a problem hiding this comment.
It doesn't seem to work very well.
There was a problem hiding this comment.
It worked correctly when you clicked "supported specifications" because that was the only time it hit the scrollIntoView() function as far as I can tell.
docs/CONTRIBUTING.md
Outdated
| @@ -25,15 +25,15 @@ The following table lists the ticket type labels we use when there is work to be | |||
| |Ticket type label |Description | | |||
| |:----------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | |||
| |L0 - security |A security vulnerability within the Marked library is discovered. | | |||
| |L1 - broken |Valid usage results in incorrect output compared to [supported specifications](README.md#specifications) OR causes marked to crash AND there is no known workaround for the issue. | | |||
| |L1 - broken |Valid usage results in incorrect output compared to [supported specifications](#README.md#specifications) OR causes marked to crash AND there is no known workaround for the issue. | | |||
There was a problem hiding this comment.
nit: I think the urls to md files should being with a slash #/README.md#specifications.
This is a common pattern for js routers so that you know its linking to a different route and not a normal anchor on the page. Thoughts?
There was a problem hiding this comment.
We determine whether it is a route or anchor by the existence of /.md$/ but we could change it to /^\\/
There was a problem hiding this comment.
I also realized, we can use #/README and drop the .md altogether which will read a little bit better.
|
@joshbruce Any objections to this? |
|
There are still some issues after this fix:
|
Hash change docs
Marked version: 0.3.19
Markdown flavor: Markdown.pl|CommonMark|GitHub Flavored Markdown|n/a
Description
Contributor
Committer
In most cases, this should be a different person than the contributor.