links-check

此插件检查你的 Markdown 文件中的死链接。

此插件已集成到默认主题中。

使用

npm i -D @vuepress/plugin-links-check@next

.vuepress/config.ts
import { linksCheckPlugin } from '@vuepress/plugin-links-check'

export default {
  plugins: [
    linksCheckPlugin({
      // 选项
    }),
  ],
}

选项

devboolean

默认值true

是否在开发服务器中检查 Markdown 中的死链接。

buildboolean | 'error'

默认值true

是否在构建时检查 Markdown 中的死链接。如果设置为 'error'，则在发现死链接时构建将失败。

exclude(string | RegExp)[] | ((link: string, isDev: boolean) => boolean)

检查时需要排除的链接。你可以使用字符串或正则表达式的列表，或者返回布尔值的函数。

.vuepress/config.ts
import { linksCheckPlugin } from '@vuepress/plugin-links-check'

export default {
  plugins: [
    linksCheckPlugin({
      exclude: [
        // 通过字符串排除链接
        '/exclude-link',
        // 通过正则表达式排除链接
        /\/exclude-link-regex/,
      ],

      // 或者通过函数排除链接
      exclude: (link, isDev) => {
        if (isDev) {
          return link.startsWith('/exclude-link-dev')
        }
        return link.startsWith('/exclude-link-build')
      },
    }),
  ],
}