terminal@fuma-nama:~

next-validate-link v1.5.2

A simple utility to validate links in your Markdown files. Never worry about broken documentation links again.

$ Features

  • Automatic link checking
  • Identifies outdated links
  • Full Markdown compatibility
  • URL fragment & query params validation

$ Integrations

-> Next.js, Nuxt.js, Astro, Fumadocs.

$ npm add next-validate-link

import { scanURLs, printErrors, validateFiles } from 'next-validate-link';
import fg from 'fast-glob';
 
const scanned = await scanURLs({
  preset: 'next'
});
 
printErrors(
  await validateFiles(await fg('content/**/*.{md,mdx}'), {
    scanned,
  }),
  true, // exit with code 1 if errors detected
);

$ cat how-it-works.md

  • Scans available URLs for Markdown files based on your Web framework
  • Extracts all links from content (e.g. Markdown files)
  • Validates each link
  • Generates validation report