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

feat: add markdown link checker to validate links #223

Merged
merged 1 commit into from
Jul 13, 2023

Conversation

asmitbm
Copy link
Member

@asmitbm asmitbm commented Jul 13, 2023

This adds a GitHub actions workflow which runs remark validate links which will check links in Markdown files in order to see if any are returning 404s. The logs will be available in each PR and Netlify as well.

I implemented the broken anchor links detection for both npm start and npm run build. So, even if we build this project locally, we'll get warnings there.

These are the key changes:

  • Added the remark validate links for checking internal links, including checking that headers exist in linked-to files
  • Added that internal link checker to the CI
  • Edited a few docs which had incorrect links

Edit:
This is the log we'll get on each PR: https://github.com/oras-project/oras-www/actions/runs/5541071028/jobs/10113990367?pr=223#step:5:1

Closes: #220

Copy link
Member

@TerryHowe TerryHowe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

Thanks! This doesn't check the jsx files though I guess, but big improvement.

@asmitbm
Copy link
Member Author

asmitbm commented Jul 13, 2023

/lgtm

Thanks! This doesn't check the jsx files though I guess, but big improvement.

Yeah it doesn't check for jsx files as of now, I will look if there's any solution available and create a separate PR.

@sajayantony sajayantony merged commit 7c32f06 into oras-project:main Jul 13, 2023
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.

Have docusaurus presubmit fail if broken links
3 participants