Skip to content

Commit 4020ad8

Browse files
ci(docs): add markdownlint and link checker workflow
1 parent 91a4759 commit 4020ad8

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

.github/workflows/docs.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Docs Quality
2+
3+
on:
4+
push:
5+
branches: [ "main", "master" ]
6+
pull_request:
7+
branches: [ "main", "master" ]
8+
9+
jobs:
10+
markdown:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- name: Markdownlint
15+
uses: actionshub/markdownlint@main
16+
with:
17+
filesToIgnore: |
18+
**/.build/**
19+
**/Pods/**
20+
**/Carthage/**
21+
**/.swiftpm/**
22+
**/DerivedData/**
23+
**/node_modules/**
24+
**/vendor/**
25+
linkcheck:
26+
runs-on: ubuntu-latest
27+
steps:
28+
- uses: actions/checkout@v4
29+
- name: Check links
30+
uses: lycheeverse/lychee-action@v1
31+
with:
32+
args: --exclude "img.shields.io|starchart.cc" --verbose --no-progress "**/*.md"
33+
env:
34+
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

0 commit comments

Comments
 (0)