-
Notifications
You must be signed in to change notification settings - Fork 391
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* initial replacement * meta changes * change few other mentions * moarrrrr changes * ai changes * Update x-chain-migration.mdx Signed-off-by: Owen <[email protected]> * some changes * PoA fix * Update api.mdx Signed-off-by: Owen <[email protected]> * small fixes * add: linkChecker, fix: majority of broken links * add cheerio as dev depend * fix gcp terraform link * fix hamburger subnet link * fix few commands * fix couple more commands * some fixes * add assets.website-files.com to whitelist * Update content/docs/api-reference/p-chain/api.mdx Co-authored-by: Meaghan FitzGerald <[email protected]> Signed-off-by: Ashutosh Tripathi <[email protected]> --------- Signed-off-by: Owen <[email protected]> Signed-off-by: Ashutosh Tripathi <[email protected]> Co-authored-by: owenwahlgren <[email protected]> Co-authored-by: Meaghan FitzGerald <[email protected]>
- Loading branch information
3 people
authored
Sep 25, 2024
1 parent
6d42a36
commit e9e7919
Showing
231 changed files
with
2,770 additions
and
2,826 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,135 @@ | ||
| import get from 'axios'; | ||
| import { readFileSync } from 'fs'; | ||
| import { load } from 'cheerio'; | ||
| import { sync as globSync } from 'glob'; | ||
|
|
||
| const baseUrl = 'http://localhost:3000'; // base url of the website | ||
|
|
||
| const whitelist = ["crates.io", "softwaretestinghelp.com", "coinbase.com", "assets.website-files.com"] // some websites return 404 for head requests, so we need to whitelist them, (fix: pass header -H 'Accept: text/html' and parse text/html) | ||
| // see https://github.com/rust-lang/crates.io/issues/788 | ||
|
|
||
| interface LinkCheckResult { | ||
| file: string; | ||
| link: string; | ||
| line: number; | ||
| isValid: boolean; | ||
| } | ||
|
|
||
| function isValidURLOrPath(url: string): boolean { | ||
| try { | ||
| new URL(url) | ||
| return true | ||
| } catch { | ||
| if (url.startsWith("{") && url.endsWith("}")) { // is a a JSX component, ignore | ||
| return false; | ||
| } | ||
| else if (url.indexOf('.') > -1) { // is a url or misconfigured path | ||
| return true; | ||
| } | ||
| // where all our content lives | ||
| return url.startsWith("/"); | ||
| } | ||
| } | ||
|
|
||
| async function checkLink(url: string): Promise<boolean> { | ||
| try { | ||
| const response = await get(url, { | ||
| timeout: 20000, // timeout to 20 seconds | ||
| maxRedirects: 5, // handle up to 5 redirects | ||
| validateStatus: function (status) { | ||
| return status >= 200 && status < 400; // resolve only if the status code is less than 400 | ||
| }, | ||
| headers: { | ||
| 'User-Agent': 'Mozilla/5.0 (compatible; LinkChecker/1.0)', // Custom User-Agent | ||
| } | ||
| }); | ||
| return response.status === 200; | ||
| } catch { | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| function extractLinksWithLineNumbers(mdxContent: string): { link: string; line: number }[] { | ||
| const lines = mdxContent.split('\n'); | ||
| const links: { link: string; line: number }[] = []; | ||
|
|
||
| lines.forEach((line, index) => { | ||
| const $ = load(`<div>${line}</div>`); | ||
| $('a').each((i, elem) => { | ||
| const href = $(elem).attr('href'); | ||
| if (href && isValidURLOrPath(href)) { | ||
| links.push({ link: href, line: index + 1 }); | ||
| } | ||
| }); | ||
|
|
||
| const markdownLinkRegex = /\[.*?\]\((.*?)\)/g; | ||
| let match; | ||
| while ((match = markdownLinkRegex.exec(line)) !== null) { | ||
| const link = match[1]; | ||
| if (isValidURLOrPath(link)) { | ||
| links.push({ link, line: index + 1 }); | ||
| } | ||
| } | ||
| }); | ||
|
|
||
| return links; | ||
| } | ||
|
|
||
| async function checkAllMdxFiles(): Promise<void> { | ||
| const files = globSync('content/**/*.mdx'); | ||
| console.log(`Found ${files.length} MDX files.`); | ||
|
|
||
| const results: LinkCheckResult[] = []; | ||
|
|
||
| for (const file of files) { | ||
| console.log(`Processing file: ${file}`); | ||
|
|
||
| const content = readFileSync(file, 'utf-8'); | ||
| const links = extractLinksWithLineNumbers(content); | ||
|
|
||
| const cache: { [link: string]: boolean } = {}; | ||
| let isValid: boolean; | ||
|
|
||
| for (const { link, line } of links) { | ||
| console.log(`Checking link: ${link} in file: ${file} (line ${line})`); | ||
|
|
||
| if (cache[link]) { | ||
| isValid = cache[link]; | ||
| } else { | ||
| isValid = await checkLink(link); // check the link | ||
| if (!isValid) { | ||
| isValid = await checkLink(baseUrl + link); // if link failed check first time, try adding the base url (for internal relative links) | ||
| } | ||
| for (const wl of whitelist) { | ||
| if (link.includes(wl)) { | ||
| isValid = true; | ||
| break; | ||
| } | ||
| } | ||
| cache[link] = isValid; | ||
| } | ||
| results.push({ file, link, line, isValid }); | ||
|
|
||
| if (!isValid) { | ||
| console.error(`\x1b[31mBroken link found\x1b[0m in ${file} (line ${line}): \x1b[33m${link}\x1b[0m`); | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
| const brokenLinks = results.filter(result => !result.isValid); | ||
| if (brokenLinks.length > 0) { | ||
| console.error(`\n\x1b[31mSummary of broken links:\x1b[0m`); | ||
| brokenLinks.forEach(result => { | ||
| console.error(`File: \x1b[36m${result.file}\x1b[0m, Line: \x1b[33m${result.line}\x1b[0m, Link: \x1b[31m${result.link}\x1b[0m`); | ||
| }); | ||
| process.exit(1); | ||
| } else { | ||
| console.log(`\x1b[32mAll links are valid.\x1b[0m`); | ||
| } | ||
| } | ||
|
|
||
| checkAllMdxFiles().catch(error => { | ||
| console.error('\x1b[31mError checking links:\x1b[0m', error); | ||
| process.exit(1); | ||
| }); |
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,30 @@ | ||
| name: Check MDX Links | ||
|
|
||
| on: | ||
| pull_request: | ||
| paths: | ||
| - '**/*.mdx' | ||
| branches: [master] | ||
|
|
||
| jobs: | ||
| check-links: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: '19' | ||
| - name: Install dependencies | ||
| run: | | ||
| yarn install --frozen-lockfile | ||
| yarn global add tsx wait-on | ||
| - name: Start Dev Server in Background | ||
| run: | | ||
| yarn dev & | ||
| - name: Wait for Dev Server to be Ready | ||
| run: | | ||
| wait-on http://localhost:3000 | ||
| - name: Check links | ||
| run: yarn check-links | ||
| - name: Stop Dev Server | ||
| run: kill $(jobs -p) || true |
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
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
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
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
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
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
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 |
|---|---|---|
|
|
@@ -966,3 +966,4 @@ Let's make a UTXO from the signed transaction created above: | |
| 0x24, 0x25, 0x26, 0x27, | ||
| ] | ||
| ``` | ||
|
|
||
Oops, something went wrong.