Link Validation

After the build, this plugin checks the links on your prerendered pages, and a broken link fails the build:

In "/docs/getting-started": link "/docs/missing-page" not-found

Add the plugin:

import { linkValidationPlugin } from "@fumapress/astro/plugins/link-validation";

createPress(content).plugins(linkValidationPlugin());

It checks links in Fumadocs layouts and your content.

Ignored and External LinksCopy Anchor Link

Full URLs are skipped by default. Use these options to skip more links, or to check full URLs too:

linkValidationPlugin({
  ignored(href) {
    return href.startsWith("/preview/");
  },
});

CI ReportsCopy Anchor Link

To annotate a pull request instead of parsing an error message, write the results to a file. "json" keeps the build passing, and "both" also fails it.

linkValidationPlugin({
  report: "json", 
});

An empty list means validation ran and found nothing. Change the file name with diagnosticsPath.

OptionsCopy Anchor Link