Add link checking
Opened this issue · 6 comments
E.g. with https://github.com/remarkjs/remark-validate-links/ (see AMWA-TV/is-09#13)
ac8355f adds checking of local Markdown links (tested with nmos-template and nmos-system).
Next to try checking remote links with https://github.com/davidtheclark/remark-lint-no-dead-urls
Unfortunately remote link checking soon triggers an GitHub abuse mechanism* due to many links to other repos so another approach may be needed
*my IP (?) was locked out for about ten minutes. Posted this initially from GitHub app via 4G.
Because of the above (which I've seen before with my Chrome link checker) we may have to check remote links after rendering on github.io. That would be done on HTML files not Markdown.
In the meantime, https://github.com/stevenvachon/broken-link-checker is useful for an offline check using blc -ro https://amwa-tv.github.io/nmos
@peterbrightwell The lint checking of local links is throwing up some false positives in nmos-parameter-registers... there are some links from the Capabilities register to e.g. Flow Attributes register which are written as e.g. ../flow-attributes/#transfer-characteristic. The checker doesn't like these, I guess because it doesn't explicitly include the file name README.md (or index.html as it ends up?). I wonder if we can educate the checker about default filename??
Ah, I just raised this again as AMWA-TV/nmos-parameter-registers#52, oops.