Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix links, add CI workflows #113

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/remarkrc-linkchecker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
plugins:
- remark-lint-are-links-valid-alive
3 changes: 3 additions & 0 deletions .github/remarkrc-lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
plugins:
- remark-preset-lint-recommended
- remark-validate-links
25 changes: 25 additions & 0 deletions .github/workflows/linkchecker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Link Checker
on:
workflow_dispatch: {}

jobs:
build:
name: Install and run link checker
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: Set Node.js
uses: actions/setup-node@v3
with:
node-version: 16.x

- name: Install yarn dependencies
uses: borales/actions-yarn@v4
with:
cmd: install # runs `yarn install`

- name: Run link checker
uses: borales/actions-yarn@v4
with:
cmd: run ci-link
25 changes: 25 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Markdown Linter
on:
pull_request: {}

jobs:
build:
name: Install and run linter
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: Set Node.js
uses: actions/setup-node@v3
with:
node-version: 16.x

- name: Install yarn dependencies
uses: borales/actions-yarn@v4
with:
cmd: install # runs `yarn install`

- name: Run linter
uses: borales/actions-yarn@v4
with:
cmd: run ci-lint
14 changes: 8 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
{
"dependencies": {
"awesome-lint": "^0.10.0",
"remark": "^10.0.1",
"remark-cli": "^6.0.1",
"remark-lint": "^6.0.1",
"awesome-lint": "^1.2.0",
"remark": "^12.0.0",
"remark-cli": "^10.0.0",
"remark-lint": "^10.0.0",
"remark-lint-are-links-valid-alive": "^0.3.0",
"remark-preset-lint-recommended": "^3.0.1",
"remark-validate-links": "^8.0.2"
"remark-preset-lint-recommended": "^7.0.0",
"remark-validate-links": "^13.0.2"
},
"scripts": {
"ci-lint": "node_modules/.bin/remark --frail --output /dev/null readme.md --rc-path .github/remarkrc-lint.yml",
"ci-link": "node_modules/.bin/remark --frail --output /dev/null readme.md --rc-path .github/remarkrc-linkchecker.yml",
"lint-md": "node_modules/.bin/remark readme.md"
},
"remarkConfig": {
Expand Down
48 changes: 20 additions & 28 deletions readme.md

Large diffs are not rendered by default.

Loading