Skip to content

Commit

Permalink
feat(doc): add github action to check markdown links (#361)
Browse files Browse the repository at this point in the history
  • Loading branch information
jonperron authored Dec 18, 2024
1 parent c71abbe commit b2a2024
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/check_markdown_links.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Check Markdown links
run-name: "Check links in documentation"

on:
push:
branches:
- main
paths:
- 'docs/**'

pull_request:
branches:
- main
paths:
- 'docs/**'


jobs:
mkdocs-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@main
- uses: byrnereese/[email protected]
with:
folder-path: 'docs/**'
file-path: './README.md'
local-only: true

0 comments on commit b2a2024

Please sign in to comment.