-
Notifications
You must be signed in to change notification settings - Fork 51
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
support link whitelisting #2
Comments
Another example:
The link is valid, but the checker cannot make sense of this particular use of an anchor/fragment, so it is likely a good candidate for whitelisting. |
Will you be invoking linkcheck from the command line (like in a shell script)? In that case, how would you prefer to give the excluded regexps? As a separate text file?
Does that seem reasonable? The other option is to provide it in line, but that makes the invocation ugly and brittle. If this configuration-by-file is okay with you, how would you prefer the Also, does it need to be RegExp or should we use glob to make the writing of that file a bit easier? Last but not least, should this feature be called whitelist or exclude or something else? Whitelist seems confusing to me, but so can exclude, I guess. |
This is an example of linkcheck output that actually shows an error, despite the link being valid:
|
I'm confused. Is this output from linkcheck? Or is it just an example of something you'd like to exclude? |
This is output from linkcheck (I updated the comment to clarify that). |
You ask valid questions. Here are some initial thoughts:
|
I will assume you want to (A) exclude the links as they are stated in I'm implementing (A). Stop me if you'd prefer (B). |
Ok done, please see this section of the readme. Let me know whether this works for you. |
I should add: |
Very nice! It seems to be working like a charm! |
As an example of where this would be useful is when running the checker over https://webdev.dart-lang.org. We currently do not yet have an Angular guide for the Router, but we do have some Angular pages that already link into the (soon to be created) Router page. It would be great if we could whitelist links to the router page.
As an example the broken-link-checker has an excludeKeywords option. We use it like this under angular.io (note the value of the
exclude
array variable):cc @kwalrath @kevmoo
The text was updated successfully, but these errors were encountered: