Check Markdown links #7
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Check Markdown links | |
| on: | |
| # triggered on PR | |
| # pull_request: {} | |
| # manual trigger | |
| workflow_dispatch: {} | |
| jobs: | |
| check-links: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| # run for .md | |
| - uses: gaurav-nelson/github-action-markdown-link-check@v1 | |
| name: 'check-md' | |
| with: | |
| file-extension: '.md' | |
| # only returns errors | |
| use-quiet-mode: 'yes' | |
| use-verbose-mode: 'yes' | |
| #location for config (different config to filter out .mdx | |
| config-file: '.github/workflows/check_broken_link_md_config.json' | |
| # folders to check parse | |
| folder-path: 'pages/docs, pages/changelogs, pages/guides' | |
| # depth from folder path | |
| max-depth: -1 | |
| # only check files changed in the PR | |
| check-modified-files-only: 'yes' | |
| # branch to compare for diff | |
| base-branch: 'main' | |
| # run for .mdx | |
| - uses: gaurav-nelson/github-action-markdown-link-check@v1 | |
| name: 'check-mdx' | |
| if: '!cancelled()' | |
| with: | |
| file-extension: '.mdx' | |
| use-quiet-mode: 'yes' | |
| use-verbose-mode: 'yes' | |
| #location for config (different config to filter out .md | |
| config-file: '.github/workflows/check_broken_link_mdx_config.json' | |
| folder-path: 'pages/docs, pages/changelogs, pages/guides' | |
| max-depth: -1 | |
| # only check files changed in the PR | |
| check-modified-files-only: 'yes' | |
| # branch to compare for diff | |
| base-branch: 'main' |