Skip to content

Commit 592b243

Browse files
author
markzegarelli
authored
Merge pull request #1557 from segmentio/link-check
[netlify-ignore]
2 parents a321855 + 7f24dec commit 592b243

File tree

5 files changed

+158
-0
lines changed

5 files changed

+158
-0
lines changed

.github/workflows/link-check.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# This is a basic workflow to help you get started with Actions
2+
3+
name: Link Check
4+
5+
# Controls when the action will run.
6+
on:
7+
# Triggers the workflow on push or pull request events but only for the master branch
8+
pull_request:
9+
10+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
11+
jobs:
12+
markdown-link-check:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@master
16+
- uses: gaurav-nelson/github-action-markdown-link-check@v1
17+
with:
18+
use-quiet-mode: 'yes'
19+
config-file: '.mlc-config.json'
20+
use-verbose-mode: 'yes'
21+
check-modified-files-only: 'yes'

.mlc-config.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"replacementPatterns": [
3+
{
4+
"pattern": "^/docs",
5+
"replacement": "/github/workspace/src"
6+
},
7+
{
8+
"pattern": "(\\S+)\/(\\s|$)",
9+
"replacement": "$1$2.md"
10+
}
11+
]
12+
}

package-lock.json

Lines changed: 122 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
"front-matter": "3.0.2",
2727
"glob": "7.1.4",
2828
"js-yaml": "3.13.1",
29+
"markdown-link-check": "^3.8.7",
2930
"markdown-link-extractor": "^1.2.2",
3031
"remark": "^11.0.2",
3132
"remark-cli": "^7.0.1",

src/utils/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,5 @@ View the [Formatting Guide](/docs/utils/formatguide/) to see some of the neat st
3030
### Why doesn't this integration page have any programmatic content?
3131

3232
The liquid scripts run based on finding a match between the page path and the key in the `_data/catalog` files. Due to renames, these can fall out of date. Check out the [Find Mismatches page](/docs/utils/find-mismatches/) for a list of possible "problem child" destinations.
33+
34+

0 commit comments

Comments
 (0)