diff --git a/.github/workflows/link-check.yml b/.github/workflows/link-check.yml new file mode 100644 index 0000000..82dafc0 --- /dev/null +++ b/.github/workflows/link-check.yml @@ -0,0 +1,24 @@ +name: Check Links +on: + push: + branches: + - main + +jobs: + check-links: + runs-on: ubuntu-latest + + steps: + - name: Checkout Repository + uses: actions/checkout@v2 + + - name: Set up Node.js + uses: actions/setup-node@v3 + with: + node-version: '14' + + - name: Install Dependencies + run: npm install -g markdown-link-check + + - name: Check Links + run: markdown-link-check . diff --git a/about.md b/about.md index f5841e1..f43d725 100644 --- a/about.md +++ b/about.md @@ -14,7 +14,7 @@ This document was built by contributors from the SustainOSS Academic Working Gro The [**Academic Working Group**](https://sustainoss.org/working-groups/academic-projects/) focuses only on open source in an academic setting. It is open to everyone. -[Richard Littauer](https://burntfen.com) is one of the facilitators and organizers for the academic working group – he can be reached at [richard@sustainoss.org](mailto:richard@sustainoss.org). [Clare Dillon](https://ie.linkedin.com/in/claredillon) and [Sayeed Choudhury](https://www.linkedin.com/in/sayeed-choudhury-4184015/) are coorganizers. Currently, they are funded through an Alfred P. Sloan grant for this and other community work. +[Richard Littauer](https://burntfen.com) is one of the facilitators and organizers for the academic working group – he can be reached at [richard@sustainoss.org](mailto:richard@sustainoss.org). [Clare Dillon](https://www.linkedin.com/in/claredillon/) and [Sayeed Choudhury](https://www.linkedin.com/in/sayeed-choudhury-4184015/) are coorganizers. Currently, they are funded through an Alfred P. Sloan grant for this and other community work. Anyone is welcome to get involved with organizing either the Academic WG, or any other part of SustainOSS. Get in touch if you are interested. diff --git a/mdlinkcheckconfig.json b/mdlinkcheckconfig.json new file mode 100644 index 0000000..e9f1587 --- /dev/null +++ b/mdlinkcheckconfig.json @@ -0,0 +1,7 @@ +{ + "ignorePatterns": [ + { + "pattern": "linkedin" + } + ] +} \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 0000000..50cac47 --- /dev/null +++ b/package.json @@ -0,0 +1,22 @@ +{ + "name": "academic-map", + "private": true, + "version": "1.0.0", + "description": "An ecosystem map for academic OSS", + "scripts": { + "build": "./build.sh", + + "lint": "markdownlint . -i _build/", + "lint-fix": "markdownlint --fix .", + + "check-links": "markdown-link-check ./*.md -c mdlinkcheckconfig.json && markdown-link-check ./**/*.md -c mdlinkcheckconfig.json", + "check-links-ci": "markdown-link-check -q ./*.md -c mdlinkcheckconfig.json && markdown-link-check ./**/*.md -q -c mdlinkcheckconfig.json", + + "test": "npm run lint && npm run check-links-ci", + "pretest": "npm run lint-fix" + }, + "devDependencies": { + "markdown-link-check": "^3.8.0", + "markdownlint": "^0.29.0" + } +}