Skip to content
Merged
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
23 changes: 3 additions & 20 deletions .github/workflows/pr-validation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
- '.github/workflows/**'

jobs:
validate-mdx:
mdx-validation:
runs-on: ubuntu-latest
steps:
- name: Checkout repo
Expand All @@ -21,27 +21,10 @@ jobs:
cache: 'npm'

- name: MDX validation dependencies
run: npm install --save-dev @mdx-js/mdx @mdx-js/loader
run: npm install --save-dev @mdx-js/mdx @mdx-js/loader glob

- name: Validate MDX files
run: |
# Find and validate all MDX files in the docs directory
find docs -name "*.mdx" -type f | while read file; do
echo "Validating: $file"
node -e "
const fs = require('fs');
const { compile } = require('@mdx-js/mdx');

try {
const content = fs.readFileSync('$file', 'utf8');
compile(content, { jsx: true });
console.log('✅ $file - Valid MDX');
} catch (error) {
console.error('❌ $file - MDX Error:', error.message);
process.exit(1);
}
"
done
run: node scripts/validate-mdx.js

- name: Check for broken links
run: |
Expand Down
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
{
"type": "module",
"devDependencies": {
"@mdx-js/loader": "^3.1.0",
"@mdx-js/mdx": "^3.1.0"
"@mdx-js/mdx": "^3.1.0",
"glob": "^10.3.10"
}
}
28 changes: 28 additions & 0 deletions scripts/validate-mdx.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import fs from 'fs';
import { compile } from '@mdx-js/mdx';
import { glob } from 'glob';

async function validateMDX() {
try {
const mdxFiles = await glob('docs/**/*.mdx');

for (const file of mdxFiles) {
console.log(`Validating: ${file}`);
try {
const content = fs.readFileSync(file, 'utf8');
await compile(content, { jsx: true });
console.log(`✅ ${file} - Valid MDX`);
} catch (error) {
console.error(`❌ ${file} - MDX Error:`, error.message);
process.exit(1);
}
}

console.log(`\n🎉 All ${mdxFiles.length} MDX files are valid!`);
} catch (error) {
console.error('❌ Validation failed:', error.message);
process.exit(1);
}
}

validateMDX();