@islandjs/plugin-check-links

A plugin for Island.js to check links in markdown files.

Install

# npm
npm install @islandjs/plugin-check-links
# yarn
yarn add @islandjs/plugin-check-links
# pnpm
pnpm install @islandjs/plugin-check-links

Usage

// .island/config.ts
import { pluginCheckLinks } from '@islandjs/plugin-check-links';
import { defineConfig } from 'islandjs';

export default defineConfig({
  plugins: [pluginCheckLinks()]
});

Options

interface DeadLinkCheckOptions {
  /**
   * Exclude links
   */
  exclude?: (string | RegExp)[];
  /**
   * External link request timeout time
   */
  timeout?: number;
}