Skip to content

Commit

Permalink
Add external URL linting for markdown files
Browse files Browse the repository at this point in the history
This commit integrates `remark-lint-no-dead-urls` into the project's
linting process, improving documentation quality by checking for dead
links.

Key changes:

- Add NPM command to verify external URLs in markdown files
- Include new command in the main lint script

Other supporting changes:

- Replace archive.ph link with Wayback Machine for better verification
- Update `remark-lint-no-dead-urls` to latest version (2.0.0)
- Update Browserslist DB to latest to avoid build errors
  • Loading branch information
undergroundwires committed Oct 1, 2024
1 parent a536c69 commit 4e06d54
Show file tree
Hide file tree
Showing 4 changed files with 1,453 additions and 2,461 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/checks.quality.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@ jobs:
- npm run lint:eslint
- npm run lint:yaml
- npm run lint:md
- npm run lint:md:relative-urls
- npm run lint:md:consistency
- npm run lint:md:relative-urls
- npm run lint:md:external-urls
os: [ macos, ubuntu, windows ]
fail-fast: false # Still interested to see results from other combinations
steps:
Expand Down
1 change: 1 addition & 0 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ See [ci-cd.md](./ci-cd.md) for more information.
- Markdown: `npm run lint:md`
- Markdown consistency `npm run lint:md:consistency`
- Markdown relative URLs: `npm run lint:md:relative-urls`
- Markdown external URLs: `npm run lint:md:external-urls`
- JavaScript/TypeScript: `npm run lint:eslint`
- Yaml: `npm run lint:yaml`

Expand Down
Loading

0 comments on commit 4e06d54

Please sign in to comment.