search

tmijs / tmi.js

💬 Javascript library for the Twitch Messaging Interface. (Twitch.tv)
https://tmijs.com
MIT License
1.55k stars 214 forks source link

Events.html is linked to as Events.md in Commands documentation page #291

Closed nic-hartley closed 5 years ago

nic-hartley commented 6 years ago

Actual behaviour: The links to the events in the Commands page in the docs go to Events.md, not Events.html. This leads to dozens, if not hundreds, of broken links on that page, which could all be fixed with a find-and-replace.

Also, they all go to #notice, not (as I assume was intended) the anchors for the actual events.

Expected behaviour: Links should go to Events.html.

nic-hartley commented 6 years ago

I realize this isn't really a bug, per se, but I'm a firm believer in good documentation, and this is a relatively easy problem to fix. If I could edit the docs, I'd probably be able to fix this with a quick regex replacement -- \[(\w+)\]\(https://docs.tmijs.org/v1.2.1/Events.md#notice\) with [\1](https://docs.tmijs.org/v1.2.1/Events.html#\1), give or take some syntax things depending on your regex engine.