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 instructions for running mdbook linkcheck #238

Merged
merged 5 commits into from
Oct 11, 2023
Merged

Conversation

GeckoEidechse
Copy link
Member

Allows checking if all relative links inside the mdBook are valid. Especially useful for ensuring updated links when moving content around.

Allows checking if all relative links inside the mdBook are valid.
Especially useful for ensuring updated links when moving content around.
@itscynxx
Copy link
Contributor

itscynxx commented Oct 10, 2023

Works and warns of links, I would suggest adding a section similar to:

mdBook-linkcheck

There's a community made package that you can use alongside mdBook to show you some potentially invalid hyperlinks in markdown files called mdBook-linkcheck

Although not required, you may find it helpful to use alongside mdBook to ensure you've linked things properly

To install mdBook-linkcheck use the following link if:

@GeckoEidechse
Copy link
Member Author

Failing link is

https://help.ea.com/en/help/pc/link-ea-and-steam/

wtf?

https://github.com/R2Northstar/NorthstarWiki/actions/runs/6484396432/job/17608135877?pr=238#step:4:420

Need figure out if there's a way to ignore external links...

@itscynxx
Copy link
Contributor

Need figure out if there's a way to ignore external links...

does adding follow-web-links = false under output.linkcheck change anything

@GeckoEidechse
Copy link
Member Author

Need figure out if there's a way to ignore external links...

does adding follow-web-links = false under output.linkcheck change anything

Was about to try that until I realised that ocular-d/md-linkcheck-action@master uses https://github.com/tcort/markdown-link-check and not https://github.com/Michael-F-Bryan/mdbook-linkcheck (i.e. a completely different tool xD)

It seems there's no pre-made Action for mdBook-linkcheck :c

@GeckoEidechse
Copy link
Member Author

I'm gonna skip CI for this PR and make a separate one instead ^^

@GeckoEidechse GeckoEidechse changed the title Update config to support linkcheck Add instructions for running mdbook linkcheck Oct 11, 2023
@GeckoEidechse GeckoEidechse marked this pull request as ready for review October 11, 2023 15:32
@GeckoEidechse
Copy link
Member Author

Gonna merge this as is for now and then focus on CI in a second PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants