Skip to content
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

Add link checking #2

Open
peterbrightwell opened this issue May 8, 2020 · 6 comments
Open

Add link checking #2

peterbrightwell opened this issue May 8, 2020 · 6 comments

Comments

@peterbrightwell
Copy link
Contributor

E.g. with https://github.com/remarkjs/remark-validate-links/ (see AMWA-TV/is-09#13)

@peterbrightwell
Copy link
Contributor Author

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

@peterbrightwell
Copy link
Contributor Author

peterbrightwell commented May 26, 2020

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.

@peterbrightwell
Copy link
Contributor Author

peterbrightwell commented May 26, 2020

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.

@peterbrightwell
Copy link
Contributor Author

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

@garethsb
Copy link
Contributor

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

@garethsb
Copy link
Contributor

Ah, I just raised this again as AMWA-TV/nmos-parameter-registers#52, oops.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants