Skip to content

Commit

Permalink
Merge pull request #467 from Remi-Gau/link_check
Browse files Browse the repository at this point in the history
[MAINT] add link checker
  • Loading branch information
yibeichan authored Apr 23, 2024
2 parents f1d4c2b + 208d5f8 commit a3f320e
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 1 deletion.
28 changes: 28 additions & 0 deletions .github/workflows/check_md_links.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Check Markdown links

# checking for any dead links in markdown files

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

on:
push:
branches:
- main
pull_request:
branches: ['*']

jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
config-file: ./mlc_config.json
folder-path: ./docs/
use-verbose-mode: yes
max-depth: -1
file-path: ./README.md,
2 changes: 1 addition & 1 deletion docs/01_introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

??? example "Tl;DR - Advantages of the current schema representation"
- Rich contexts for a questionnaire with JSON-LD rather than a "flat" csv file.
- A single source of curated assessments from [ReproSchema Library](https://github.com/reproschema-library)
- A single source of curated assessments from [ReproSchema Library](https://github.com/ReproNim/reproschema-library)
- Each `item` (i.e question), `activity` (i.e questionnaire), and `protocol`
(i.e set of questionnaires) provides unique and persistent identifiers.
- Versions of a given questionnaire can be tracked (e.g., PHQ-9, PHQ-8).
Expand Down
9 changes: 9 additions & 0 deletions mlc_config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"ignorePatterns": [
{"pattern": "http://127.0.0.1:8000/"},
{"pattern": "^https://jsonformatter.curiousconcept.com/"},
{"pattern": "^http.*://schema.repronim.org/.*"},
{"pattern": "^http://schema.org/version/2.0/"}

]
}

0 comments on commit a3f320e

Please sign in to comment.