github-action-markdown-link-check icon indicating copy to clipboard operation
github-action-markdown-link-check copied to clipboard

Published 20 hours ago • verified publisher icon gaurav-nelson

Is there a way to make this work for relative links within a mkdocs project?

Open byrnereese opened this issue 4 years ago • 2 comments
trafficstars

This looks like an excellent project. When I run it with my mkdocs repository, all of the relative links are marked as broken. I am wondering if there is a way for relative links to be resolved somehow?

byrnereese avatar Aug 14 '21 22:08 byrnereese

So I continue to work on this problem. I have adapted my workflow as follows.

First, I publish the mkdocs site to github pages. With this site up and running, in theory, links should resolve. However, I have no way to specify the base URL for relative links via the github action. So all of my markdown links are coming back as invalid. So my problem persists.

byrnereese avatar Aug 15 '21 23:08 byrnereese

Thanks @byrnereese The markdown-link-check library only checks hyperlinks. Can you provide a link to the failed tests?

You can configure a BASEURL using https://github.com/tcort/markdown-link-check#config-file-format

This might not be the answer but if you can provide the link for the failed test I can have a look.

gaurav-nelson avatar Aug 16 '21 00:08 gaurav-nelson