Skip to content

Commit

Permalink
Adding package.json for linting and link checking
Browse files Browse the repository at this point in the history
Closes #6
  • Loading branch information
RichardLitt committed Jan 24, 2024
1 parent ccea1c9 commit 3082021
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 1 deletion.
24 changes: 24 additions & 0 deletions .github/workflows/link-check.yml
Original file line number Diff line number Diff line change
@@ -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 .
2 changes: 1 addition & 1 deletion about.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [[email protected]](mailto:[email protected]). [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 [[email protected]](mailto:[email protected]). [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.

Expand Down
7 changes: 7 additions & 0 deletions mdlinkcheckconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"ignorePatterns": [
{
"pattern": "linkedin"
}
]
}
22 changes: 22 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -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"
}
}

0 comments on commit 3082021

Please sign in to comment.