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

Documentation Link Checker #782

Merged
merged 4 commits into from
Feb 19, 2025
Merged

Documentation Link Checker #782

merged 4 commits into from
Feb 19, 2025

Conversation

andymandias
Copy link
Collaborator

To help catch link errors in the documentation this adds mdbook-linkcheck to mdbook output. Running it locally caught a few errors (including recently found broken link fixed by #780), which are fixed in this PR as well.

The changes to GH workflows are due to this note:

When multiple [output] items are specified, mdbook tries to ensure that each [output] gets its own sub-directory within the build-dir (book/ by default).
That means if you go from only having the HTML renderer enabled to enabling both HTML and the linkchecker, your HTML will be placed in book/html/ instead of just book/ like before.

But, I'm not sure how to test the change.

@casperstorm casperstorm merged commit 0367b0f into main Feb 19, 2025
1 check passed
@casperstorm casperstorm deleted the mdbook-linkcheck branch February 19, 2025 20:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants