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

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

Open
byrnereese opened this issue Aug 14, 2021 · 2 comments
Labels
question Further information is requested

Comments

@byrnereese
Copy link

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
Copy link
Author

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.

@gaurav-nelson
Copy link
Owner

gaurav-nelson commented Aug 16, 2021

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 gaurav-nelson added the question Further information is requested label Aug 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants