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 checklinks tox env and shell script. #955

Merged
merged 3 commits into from
May 8, 2020

Conversation

waylan
Copy link
Member

@waylan waylan commented May 8, 2020

This is using the Node.js tool from tcort/markdown-link-check which runs on Markdown input.

Note that there are currently quite a few broken links in the documentation. We need to be checking these regularly. I'll be fixing them as I continue to work on this PR.

I should also note that this tool will properly verify MkDocs' internal links if they are proper relative links, but will error on internal absolute links. This fits MkDocs' requirements and ensures absolute links don't slip in. This provides an added benefit we might miss if we were using an HTML based tool on the built site.

If only the tool reported the line numbers where the links were defined (see tcort/markdown-link-check#93).

@waylan waylan added the work-in-progress A partial solution. More changes will be coming. label May 8, 2020
@waylan
Copy link
Member Author

waylan commented May 8, 2020

Ran into tcort/markdown-link-check#86 in the Contributing Guide, so I used a normal link, rather than an automatic link.

@waylan waylan merged commit a605265 into Python-Markdown:master May 8, 2020
@waylan waylan deleted the linkcheck branch May 8, 2020 01:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
work-in-progress A partial solution. More changes will be coming.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant