feat(plugin-links-check): add links check plugin

vuepress · Feb 21, 2024 · 082a953 · 082a953
1 parent 6927f23
commit 082a953
Show file tree

Hide file tree

Showing 33 changed files with 454 additions and 40 deletions.
diff --git a/docs/plugins/active-header-links.md b/docs/plugins/active-header-links.md
@@ -48,10 +48,10 @@ export default {
 
   Selector of _header anchor_.
 
-  You don't need to specify this option unless you have changed the `permalinkClass` option of [markdown-it-anchor](https://github.com/valeriangalliat/markdown-it-anchor#readme) via [markdown.anchor](../config.md#markdown-anchor).
+  You don't need to specify this option unless you have changed the `permalinkClass` option of [markdown-it-anchor](https://github.com/valeriangalliat/markdown-it-anchor#readme) via [markdown.anchor](https://vuejs.press/reference/config.html#markdown-anchor).
 
 - Also see:
-  - [Guide > Markdown > Syntax Extensions > Header Anchors](../../guide/markdown.md#header-anchors)
+  - [Guide > Markdown > Syntax Extensions > Header Anchors](https://vuejs.press/guide/markdown.html#header-anchors)
 
 ### delay
 

diff --git a/docs/plugins/container.md b/docs/plugins/container.md
@@ -6,7 +6,7 @@ Register markdown custom containers in your VuePress site.
 
 This plugin simplifies the use of [markdown-it-container](https://github.com/markdown-it/markdown-it-container), but also retains its original capabilities.
 
-The [Custom Containers](../default-theme/markdown.md#custom-containers) of default theme is powered by this plugin.
+The [Custom Containers](../themes/default/markdown.md#custom-containers) of default theme is powered by this plugin.
 
 ## Usage
 
@@ -85,7 +85,7 @@ export default {
 ```
 
 - Also see:
-  - [Guide > I18n](../../guide/i18n.md)
+  - [Guide > I18n](https://vuejs.press/guide/i18n.html)
 
 ### before
 

diff --git a/docs/plugins/docsearch.md b/docs/plugins/docsearch.md
@@ -315,21 +315,21 @@ export default {
 ```
 
 - Also see:
-  - [Guide > I18n](../../guide/i18n.md)
+  - [Guide > I18n](https://vuejs.press/guide/i18n.html)
 
 ### indexBase
 
 - Type: `string`
 
-- Default: [base](../config.md#base)
+- Default: [base](https://vuejs.press/reference/config.html#base)
 
 - Details:
 
   The base path of the search index.
 
   If you are deploying your site to multiple domains, you don't need to submit all of them to DocSearch and generate search index separately. You could choose one of the domains as the _index domain_, and only submit the _index domain_ to Docsearch for crawling search index. Then, you could reuse the search index across all deployments.
 
-  However, if the [base](../config.md#base) of your deployments are different for different domains, you need to set the option to the [base](../config.md#base) of your _index domain_, so that other deployments could reuse the search index correctly.
+  However, if the [base](https://vuejs.press/reference/config.html#base) of your deployments are different for different domains, you need to set the option to the [base](https://vuejs.press/reference/config.html#base) of your _index domain_, so that other deployments could reuse the search index correctly.
 
 ### injectStyles
 

diff --git a/docs/plugins/external-link-icon.md b/docs/plugins/external-link-icon.md
@@ -56,7 +56,7 @@ export default {
 ```
 
 - Also see:
-  - [Guide > I18n](../../guide/i18n.md)
+  - [Guide > I18n](https://vuejs.press/guide/i18n.html)
 
 ## Frontmatter
 

diff --git a/docs/plugins/git.md b/docs/plugins/git.md
@@ -4,7 +4,7 @@
 
 This plugin will collect git information of your pages, including the created and updated time, the contributors, etc.
 
-The [lastUpdated](../default-theme/config.md#lastupdated) and [contributors](../default-theme/config.md#contributors) of default theme is powered by this plugin.
+The [lastUpdated](../themes/default/config.md#lastupdated) and [contributors](../themes/default/config.md#contributors) of default theme is powered by this plugin.
 
 This plugin is mainly used to develop themes. You won't need to use it directly in most cases.
 

diff --git a/docs/plugins/links-check.md b/docs/plugins/links-check.md
@@ -0,0 +1,76 @@
+# links-check
+
+<NpmBadge package="@vuepress/plugin-links-check" />
+
+This plugin will check dead links in your markdown files.
+
+This plugin has been integrated into the default theme.
+
+## Usage
+
+```bash
+npm i -D @vuepress/plugin-links-check@next
+```
+
+```ts
+import { linksCheckPlugin } from '@vuepress/plugin-links-check'
+
+export default {
+  plugins: [
+    linksCheckPlugin({
+      // options
+    }),
+  ],
+}
+```
+
+## Options
+
+### dev
+
+- Type: `boolean`
+
+- Default: `true`
+
+- Details:
+
+  Whether check dead links in markdown in devServer
+
+### build
+
+- Type: `boolean | 'error'`
+
+- Default: `true`
+
+- Details:
+
+  Whether check dead links in markdown in build. If set to `'error'`, the build will fail if there are dead links.
+
+### exclude
+
+- Type: `(string | RegExp)[] | ((link: string, isDev: boolean) => boolean)`
+
+- Details:
+
+  The links that should be excluded from checking. You can use a list of strings or regular expressions, or a function that returns a boolean.
+
+- Example:
+
+  ```ts
+  linksCheckPlugin({
+    exclude: [
+      // exclude links by string
+      '/exclude-link',
+      // exclude links by regex
+      /\/exclude-link-regex/,
+    ],
+
+    // or exclude links by function
+    exclude: (link, isDev) => {
+      if (isDev) {
+        return link.startsWith('/exclude-link-dev')
+      }
+      return link.startsWith('/exclude-link-build')
+    },
+  })
+  ```
diff --git a/docs/plugins/search.md b/docs/plugins/search.md
@@ -66,7 +66,7 @@ export default {
 ```
 
 - Also see:
-  - [Guide > I18n](../../guide/i18n.md)
+  - [Guide > I18n](https://vuejs.press/guide/i18n.html)
 
 ### hotKeys
 

diff --git a/docs/plugins/theme-data.md b/docs/plugins/theme-data.md
@@ -2,7 +2,7 @@
 
 <NpmBadge package="@vuepress/plugin-theme-data" />
 
-Provide client data for your theme, with VuePress [i18n](../../guide/i18n.md) support.
+Provide client data for your theme, with VuePress [i18n](https://vuejs.press/guide/i18n.html) support.
 
 This plugin is mainly used to develop themes, and has been integrated into the default theme. You won't need to use it directly in most cases.
 

diff --git a/docs/plugins/toc.md b/docs/plugins/toc.md
@@ -24,7 +24,7 @@ export default {
 
 ## Differences with Markdown TOC Syntax
 
-Similar to the [Table of Contents Markdown Syntax](../../guide/markdown.md#table-of-contents), the TOC component that provided by this plugin could be used in your markdown content directly:
+Similar to the [Table of Contents Markdown Syntax](https://vuejs.press/guide/markdown.html#table-of-contents), the TOC component that provided by this plugin could be used in your markdown content directly:
 
 ```md
 <!-- markdown toc syntax -->

diff --git a/docs/themes/default/plugin.md b/docs/themes/default/plugin.md
@@ -58,27 +58,27 @@ export default {
 - Also see:
   - [Default Theme > Markdown > Custom Containers](./markdown.md#custom-containers)
 
-## themePlugins.externalLinkIcon
+## themePlugins.copyCode
 
-- Type: `boolean`
+- Type: `CopyCodePluginOptions | boolean`
 
 - Default: `true`
 
 - Details:
 
-  Enable [@vuepress/plugin-external-link-icon](../../plugins/external-link-icon.md) or not.
+  Enable [@vuepress/plugin-copy-code](../../plugins/copy-code.md) or not.
 
-## themePlugins.copyCode
+  Object value is supported as plugin options.
 
-- Type: `CopyCodePluginOptions | boolean`
+## themePlugins.externalLinkIcon
+
+- Type: `boolean`
 
 - Default: `true`
 
 - Details:
 
-  Enable [@vuepress/plugin-copy-code](../../plugins/copy-code.md) or not.
-
-  Object value is supported as plugin options.
+  Enable [@vuepress/plugin-external-link-icon](../../plugins/external-link-icon.md) or not.
 
 ## themePlugins.git
 
@@ -90,6 +90,16 @@ export default {
 
   Enable [@vuepress/plugin-git](../../plugins/git.md) or not.
 
+## themePlugins.linksCheck
+
+- Type: `LinksCheckPluginOptions | boolean`
+
+- Default: `true`
+
+- Details:
+
+  Enable [@vuepress/plugin-links-check](../../plugins/links-check.md) or not.
+
 ## themePlugins.mediumZoom
 
 - Type: `boolean`
@@ -110,6 +120,16 @@ export default {
 
   Enable [@vuepress/plugin-nprogress](../../plugins/nprogress.md) or not.
 
+## themePlugins.prismjs
+
+- Type: `boolean`
+
+- Default: `true`
+
+- Details:
+
+  Enable [@vuepress/plugin-prismjs](../../plugins/prismjs.md) or not.
+
 ## themePlugins.seo
 
 - Type: `SeoPluginOptions | boolean`

diff --git a/docs/zh/plugins/active-header-links.md b/docs/zh/plugins/active-header-links.md
@@ -48,10 +48,10 @@ export default {
 
   _标题锚点_ 的选择器。
 
-  你通常不需要设置该选项，除非你通过 [markdown.anchor](../config.md#markdown-anchor) 修改了 [markdown-it-anchor](https://github.com/valeriangalliat/markdown-it-anchor#readme) 的 `permalinkClass` 选项。
+  你通常不需要设置该选项，除非你通过 [markdown.anchor](https://vuejs.press/zh/reference/config.html#markdown-anchor) 修改了 [markdown-it-anchor](https://github.com/valeriangalliat/markdown-it-anchor#readme) 的 `permalinkClass` 选项。
 
 - 参考：
-  - [指南 > Markdown > 语法扩展 > 标题锚点](../../guide/markdown.md#标题锚点)
+  - [指南 > Markdown > 语法扩展 > 标题锚点](https://vuejs.press/zh/guide/markdown.html#标题锚点)
 
 ### delay
 

diff --git a/docs/zh/plugins/container.md b/docs/zh/plugins/container.md
@@ -6,7 +6,7 @@
 
 该插件简化了 [markdown-it-container](https://github.com/markdown-it/markdown-it-container) 的使用方法，但同时也保留了其原本的能力。
 
-默认主题的 [自定义容器](../default-theme/markdown.md#自定义容器) 就是由该插件支持的。
+默认主题的 [自定义容器](../themes/default/markdown.md#自定义容器) 就是由该插件支持的。
 
 ## 使用方法
 
@@ -85,7 +85,7 @@ export default {
 ```
 
 - 参考：
-  - [指南 > 多语言支持](../../guide/i18n.md)
+  - [指南 > 多语言支持](https://vuejs.press/zh/guide/i18n.html)
 
 ### before
 

diff --git a/docs/zh/plugins/docsearch.md b/docs/zh/plugins/docsearch.md
@@ -314,21 +314,21 @@ export default {
 ```
 
 - 参考：
-  - [指南 > 多语言支持](../../guide/i18n.md)
+  - [指南 > 多语言支持](https://vuejs.press/zh/guide/i18n.html)
 
 ### indexBase
 
 - 类型： `string`
 
-- 默认值： [base](../config.md#base)
+- 默认值： [base](https://vuejs.press/zh/reference/config.html#base)
 
 - 详情：
 
   搜索索引基础路径。
 
   如果你需要把你的站点部署到不同的域名上，你不需要把它们全都提交到 Docsearch 上来分别生成搜索索引。你可以选择其中一个域名作为 _索引域名_ ，并且仅将 _索引域名_ 提交到 DocSearch 上来爬去搜索索引。然后，你就可以在不同的部署域名下复用索引。
 
-  如果你不同部署域名下的 [base](../config.md#base) 是不一样的，你就需要将这个配置设置成 _索引域名_ 的 [base](../config.md#base) ，这样其他的部署域名就可以正确复用索引了。
+  如果你不同部署域名下的 [base](https://vuejs.press/zh/reference/config.html#base) 是不一样的，你就需要将这个配置设置成 _索引域名_ 的 [base](https://vuejs.press/zh/reference/config.html#base) ，这样其他的部署域名就可以正确复用索引了。
 
 ### injectStyles
 

diff --git a/docs/zh/plugins/external-link-icon.md b/docs/zh/plugins/external-link-icon.md
@@ -56,7 +56,7 @@ export default {
 ```
 
 - 参考：
-  - [指南 > 多语言支持](../../guide/i18n.md)
+  - [指南 > 多语言支持](https://vuejs.press/zh/guide/i18n.html)
 
 ## Frontmatter
 

diff --git a/docs/zh/plugins/git.md b/docs/zh/plugins/git.md
@@ -4,7 +4,7 @@
 
 该插件会收集你的页面的 Git 信息，包括创建和更新时间、贡献者等。
 
-默认主题的 [lastUpdated](../default-theme/config.md#lastupdated) 和 [contributors](../default-theme/config.md#contributors) 就是由该插件支持的。
+默认主题的 [lastUpdated](../themes/default/config.md#lastupdated) 和 [contributors](../themes/default/config.md#contributors) 就是由该插件支持的。
 
 该插件主要用于开发主题，大部分情况下你不需要直接使用它。
 

diff --git a/docs/zh/plugins/links-check.md b/docs/zh/plugins/links-check.md
@@ -0,0 +1,76 @@
+# links-check
+
+<NpmBadge package="@vuepress/plugin-links-check" />
+
+此插件将检查您的 markdown 文件中的死链接。
+
+此插件已集成到默认主题中。
+
+## 使用
+
+```bash
+npm i -D @vuepress/plugin-links-check@next
+```
+
+```ts
+import { linksCheckPlugin } from '@vuepress/plugin-links-check'
+
+export default {
+  plugins: [
+    linksCheckPlugin({
+      // 选项
+    }),
+  ],
+}
+```
+
+## 选项
+
+### dev
+
+- 类型：`boolean`
+
+- 默认值：`true`
+
+- 详情：
+
+  是否在开发服务器中检查 markdown 中的死链接
+
+### build
+
+- 类型：`boolean | 'error'`
+
+- 默认值：`true`
+
+- 详情：
+
+  是否在构建中检查 markdown 中的死链接。如果设置为 `'error'`，则构建将在存在死链接时失败。
+
+### exclude
+
+- 类型：`(string | RegExp)[] | ((link: string, isDev: boolean) => boolean)`
+
+- 详情：
+
+  应该从检查中排除的链接。您可以使用字符串或正则表达式的列表，或者返回布尔值的函数。
+
+- 示例：
+
+  ```ts
+  linksCheckPlugin({
+    exclude: [
+      // 通过字符串排除链接
+      '/exclude-link',
+      // 通过正则表达式排除链接
+      /\/exclude-link-regex/,
+    ],
+
+    // 或者通过函数排除链接
+    exclude: (link, isDev) => {
+      if (isDev) {
+        return link.startsWith('/exclude-link-dev')
+      }
+      return link.startsWith('/exclude-link-build')
+    },
+  })
+  ```