next-validate-link

import { validateFiles, scanURLs, printErrors, readFiles } from 'next-validate-link'; import path from 'node:path'; import process from 'node:process'; async function runValidation() { const projectRoot = process.cwd(); // Adjust to your project root if necessary // Example: target all markdown and mdx files in a 'docs' directory const markdownGlob = path.join(projectRoot, 'docs/**/*.{md,mdx}'); // Scan available URLs based on your framework (e.g., 'next', 'astro', 'nuxt', 'waku', 'react-router') // For Next.js, it will auto-detect pages from your file system. const scannedUrls = await scanURLs({ preset: 'next', // Use 'next' for Next.js projects // pages: ['/custom-page-path', '/another-page'], // Override auto-detected pages if needed }); // Read the markdown files to be validated const filesToValidate = await readFiles(markdownGlob); const validationOptions = { scanned: scannedUrls, // Provide the URLs scanned from your project checkRelativePaths: true, // Validate relative file paths (e.g., `../foo.md`) checkRelativeUrls: true, // Validate relative URLs (e.g., `/some-page`) checkExternal: true, // Validate external HTTP/HTTPS links (requires network access) baseUrl: 'https://your-live-site.com', // Base URL for resolving absolute paths // pathToUrl: (file) => `/docs/${path.basename(file, path.extname(file))}`, // Custom path-to-URL resolver // You can also pass custom remark plugins or a custom Markdown validator function }; console.log(` Validating markdown links in: ${markdownGlob}...`); const results = await validateFiles(filesToValidate, validationOptions); // Print errors and optionally exit with a non-zero code if issues are found const hasErrors = printErrors(results, true); // true means exit with code 1 on errors if (hasErrors) { console.error('\nValidation completed with errors.'); } else { console.log('\nAll markdown links are valid!'); } } runValidation().catch(console.error);