This GitHub action checks all Markdown files in your repository for broken links.
Explore the docs »
Report Bug
·
Request Feature
This project is deprecated.
A GitHub action based on markdown-link-check for validating links in Markdown based files.
- Uses fd and not
find
Create a new file in your repository .github/workflows/linkcheck.yml.
on:
push:
paths:
- '*.md'
- '/docs/*'
name: Testing linkcheck
jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: md-linkcheck
uses: ocular-d/md-linkcheck-action@masterThis will run this action every time you push Markdown files .md to the root of the repository
or do the top level of your /docs repository.
Run As Cron
on:
schedule:
# * is a special character in YAML so you have to quote this string
- cron: '*/15 * * * *'
paths:
- '*.md'
- '/docs/*'
name: Testing linkcheck
jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: md-linkcheck
uses: ocular-d/md-linkcheck-action@masterThis will run this action every 15 minutes.
We are a community effort, and everybody is most welcome to participate!
Be it filing bugs, formulating enhancements, creating pull requests, or any other means of contribution, we encourage contributions from everyone.
Distributed under the GPLv2 license.