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

Allow disabling linkcheck anchor checks for specific URLs #11484

Closed
yukiisbored opened this issue Jul 7, 2023 · 2 comments · Fixed by #11489
Closed

Allow disabling linkcheck anchor checks for specific URLs #11484

yukiisbored opened this issue Jul 7, 2023 · 2 comments · Fixed by #11489
Labels
builder:linkcheck type:enhancement enhance or introduce a new feature

Comments

@yukiisbored
Copy link

Is your feature request related to a problem? Please describe.
It appears GitHub has made the Markdown renderer/file viewer require JavaScript which breaks linkcheck anchor checks.

Describe the solution you'd like

A config which disables the linkcheck anchors check based on a regex of the entire URL would allow for cases like these to be handled while still validating whether the page itself exists and keep anchor checks enabled for others.

linkcheck_anchors_disabled = [
   # Requires JavaScript
   r'https://github.com'
]

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context

This is what the page looks like without JavaScript enabled:

Capture d’écran 2023-07-07 à 17 00 57
@yukiisbored yukiisbored changed the title Allow ignoring linkcheck anchor checks for specific URLs Allow disabling linkcheck anchor checks for specific URLs Jul 7, 2023
@francoisfreitag francoisfreitag added builder:linkcheck type:enhancement enhance or introduce a new feature labels Jul 10, 2023
@picnixz
Copy link
Member

picnixz commented Jul 13, 2023

@yukiisbored Just to be clear, if the url is

  • https://github.com/org/repo#anchor, or
  • https://github.com/org/repo/blob/main/file.ext#anchor,

you want linkcheck to only check that https://github.com/org/repo and https://github.com/org/repo/blob/main/file.ext exist without checking the anchors in the README or in file.ext respectively ?

@yukiisbored
Copy link
Author

@picnixz yup, that is correct.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 24, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
builder:linkcheck type:enhancement enhance or introduce a new feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants