-
Notifications
You must be signed in to change notification settings - Fork 238
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2507 from meilisearch/broken-links-checker-mei-23
[MEI-23]: Broken links checker
- Loading branch information
Showing
25 changed files
with
3,700 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# GitHub Action for Validating Documentation Links | ||
|
||
This action ensures that internal links in `.mdx` files in the `/docs/` directory are valid. It runs on every pull request that includes changes to these files. | ||
|
||
The action is triggered by the workflow defined in `.github/workflows/validate-docs-links.yml`. | ||
|
||
## Usage | ||
|
||
This action is written in TypeScript and compiled locally before being pushed to GitHub. | ||
|
||
To make changes: | ||
|
||
- Edit the `src/index.ts` file. | ||
- Navigate to the script folder `cd .github/actions/validate-docs-links` | ||
- Run `npm install` to install dependencies. | ||
- Run `npm run build` to compile code. This will create an updated `lib/index.js`. | ||
- Commit and push changes to GitHub. |
Large diffs are not rendered by default.
Oops, something went wrong.
2,376 changes: 2,376 additions & 0 deletions
2,376
.github/actions/validate-docs-links/lib/licenses.txt
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"type": "module" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
{ | ||
"private": true, | ||
"type": "module", | ||
"exports": "./lib/index.js", | ||
"files": [ | ||
"src" | ||
], | ||
"scripts": { | ||
"build": "npm run types && ncc -m -o ./lib build src/index.ts --license licenses.txt", | ||
"types": "tsc" | ||
}, | ||
"devDependencies": { | ||
"@types/github-slugger": "^1.3.0", | ||
"@vercel/ncc": "0.34.0" | ||
}, | ||
"dependencies": { | ||
"@actions/core": "^1.10.0", | ||
"@actions/github": "^5.1.1", | ||
"@types/node": "^20.4.1", | ||
"github-slugger": "1.2.0", | ||
"gray-matter": "4.0.2", | ||
"rehype-raw": "4.0.1", | ||
"remark-parse": "7.0.1", | ||
"remark-rehype": "5.0.0", | ||
"typescript": "^5.1.6", | ||
"unified": "8.4.1", | ||
"unist-util-visit": "2.0.0" | ||
} | ||
} |
Oops, something went wrong.