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

proposal: Add and enable mdbook-link check by default #495

Open
3 tasks done
jzohrab opened this issue Nov 19, 2023 · 0 comments
Open
3 tasks done

proposal: Add and enable mdbook-link check by default #495

jzohrab opened this issue Nov 19, 2023 · 0 comments
Assignees
Labels

Comments

@jzohrab
Copy link

jzohrab commented Nov 19, 2023

Checklist

  • I am using the latest version of this action.
  • I have read the latest README and followed the instructions.
  • I have read the latest GitHub Actions official documentation and learned the basic spec and concepts.

Describe your proposal

Thank you for the helpful project!

Checking for broken links is such a common and necessary activity that adding default support for it would be super.

https://github.com/Michael-F-Bryan/mdbook-linkcheck#getting-started has a short script for getting a link checker.

Describe the solution you'd like

I think that all that would be needed would be for users to specify a step in their toml file:

[output.linkcheck]

At least on my machine, when I set up the link checker with the below script, everything runs as expected:

RELEASE=https://github.com/Michael-F-Bryan/mdbook-linkcheck/releases/download/v0.7.7/mdbook-linkcheck.x86_64-apple-darwin.zip
mkdir -p mdbook-linkcheck && cd "$_" && \
  curl -L $RELEASE -o mdbook-linkcheck.zip && \
  unzip "$_" && \
  chmod +x mdbook-linkcheck && \
  export PATH=$PWD:$PATH && \
  cd ..

Describe alternatives you've considered

Perhaps a short link in the README to the link checker.

Additional context

Thank you very much!

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

No branches or pull requests

2 participants