feat(build): allow ignoring dead links (#586) (#793)

vuejs · Jun 25, 2022 · 19b0758 · 19b0758
1 parent ddf876d
commit 19b0758
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 4 deletions.
diff --git a/src/node/config.ts b/src/node/config.ts
@@ -64,6 +64,13 @@ export interface UserConfig<ThemeConfig = any> {
    * @experimental
    */
   mpa?: boolean
+
+  /**
+   * Don't fail builds due to dead links.
+   *
+   * @default false
+   */
+  ignoreDeadLinks?: boolean
 }
 
 export type RawConfigExports<ThemeConfig = any> =
@@ -74,7 +81,13 @@ export type RawConfigExports<ThemeConfig = any> =
 export interface SiteConfig<ThemeConfig = any>
   extends Pick<
     UserConfig,
-    'markdown' | 'vue' | 'vite' | 'shouldPreload' | 'mpa' | 'lastUpdated'
+    | 'markdown'
+    | 'vue'
+    | 'vite'
+    | 'shouldPreload'
+    | 'mpa'
+    | 'lastUpdated'
+    | 'ignoreDeadLinks'
   > {
   root: string
   srcDir: string
@@ -152,7 +165,8 @@ export async function resolveConfig(
     vue: userConfig.vue,
     vite: userConfig.vite,
     shouldPreload: userConfig.shouldPreload,
-    mpa: !!userConfig.mpa
+    mpa: !!userConfig.mpa,
+    ignoreDeadLinks: userConfig.ignoreDeadLinks
   }
 
   return config

diff --git a/src/node/plugin.ts b/src/node/plugin.ts
@@ -44,7 +44,8 @@ export async function createVitePressPlugin(
     site,
     vue: userVuePluginOptions,
     vite: userViteConfig,
-    pages
+    pages,
+    ignoreDeadLinks
   } = siteConfig
 
   let markdownToVue: Awaited<ReturnType<typeof createMarkdownToVueRenderFn>>
@@ -153,7 +154,7 @@ export async function createVitePressPlugin(
     },
 
     renderStart() {
-      if (hasDeadLinks) {
+      if (hasDeadLinks && !ignoreDeadLinks) {
         throw new Error(`One or more pages contain dead links.`)
       }
     },