Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 8 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
### GitHub Action - Markdown link check 🔗✔️
[![GitHub Marketplace](https://img.shields.io/badge/GitHub%20Marketplace-Markdown%20link%20check-brightgreen?style=for-the-badge)](https://github.com/marketplace/actions/markdown-link-check-action)

Forked from [gaurav-nelson/github-action-markdown-link-check](https://github.com/gaurav-nelson/github-action-markdown-link-check), which is no longer maintained.
> Forked from [gaurav-nelson/github-action-markdown-link-check](https://github.com/gaurav-nelson/github-action-markdown-link-check), which is no longer maintained.

This GitHub action checks all Markdown files in your repository for broken links. (Uses [tcort/markdown-link-check](https://github.com/tcort/markdown-link-check))

Expand All @@ -18,23 +18,10 @@ This GitHub action checks all Markdown files in your repository for broken links
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: actions/checkout@v4
- uses: tcort/github-action-markdown-link-check@v1
```

### Real-life usage samples

Following is a list of some of the repositories which are using GitHub Action -
Markdown link check.

1. [netdata](https://github.com/netdata/netdata/blob/master/.github/workflows/docs.yml) ![](https://img.shields.io/github/stars/netdata/netdata?style=social)
1. [GoogleChrome/lighthouse (Weekly cron job)](https://github.com/GoogleChrome/lighthouse/blob/master/.github/workflows/cron-weekly.yml)
![](https://img.shields.io/github/stars/GoogleChrome/lighthouse?style=social)
1. [tendermint/tendermint](https://github.com/tendermint/tendermint/blob/master/.github/workflows/markdown-links.yml)
![](https://img.shields.io/github/stars/tendermint/tendermint?style=social)
1. [pyroscope-io/pyroscope](https://github.com/pyroscope-io/pyroscope/blob/main/.github/workflows/lint-markdown.yml)
![](https://img.shields.io/github/stars/pyroscope-io/pyroscope?style=social)

## Configuration

- [Custom variables](#custom-variables)
Expand Down Expand Up @@ -71,7 +58,7 @@ jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: actions/checkout@v4
- uses: tcort/github-action-markdown-link-check@v1
with:
use-quiet-mode: 'yes'
Expand Down Expand Up @@ -104,7 +91,7 @@ jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: actions/checkout@v4
- uses: tcort/github-action-markdown-link-check@v1
with:
use-quiet-mode: 'yes'
Expand Down Expand Up @@ -152,7 +139,7 @@ jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: actions/checkout@v4
- uses: tcort/github-action-markdown-link-check@v1
with:
use-quiet-mode: 'yes'
Expand All @@ -170,7 +157,7 @@ jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: actions/checkout@v4
- uses: tcort/github-action-markdown-link-check@v1
with:
use-quiet-mode: 'yes'
Expand Down Expand Up @@ -220,7 +207,7 @@ jobs:
runs-on: ubuntu-latest
# check out the latest version of the code
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

# Checks the status of hyperlinks in .md files in verbose mode
- name: Check links
Expand All @@ -242,7 +229,7 @@ GitHub Action - Markdown link check follows the [GitHub recommended versioning s

1. To use a specific released version of the action ([Releases](https://github.com/tcort/github-action-markdown-link-check/releases)):
```yml
- uses: tcort/github-action-markdown-link-check@1
- uses: tcort/github-action-markdown-link-check@v1
```
1. To use a major version of the action:
```yml
Expand Down