feat(build): allow ignoring only localhost dead links (#1821)

vuejs · Jan 20, 2023 · fe52fa3 · fe52fa3
1 parent 9986f6c
commit fe52fa3
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/docs/config/app-configs.md b/docs/config/app-configs.md
@@ -86,10 +86,10 @@ type HeadConfig =
 
 ## ignoreDeadLinks
 
-- Type: `boolean`
+- Type: `boolean | 'localhostLinks'`
 - Default: `false`
 
-When set to `true`, VitePress will not fail builds due to dead links.
+When set to `true`, VitePress will not fail builds due to dead links. When set to `localhostLinks`, the build will fail on dead links, but won't check `localhost` links.
 
 ```ts
 export default {

diff --git a/src/node/config.ts b/src/node/config.ts
@@ -73,7 +73,7 @@ export interface UserConfig<ThemeConfig = any>
    *
    * @default false
    */
-  ignoreDeadLinks?: boolean
+  ignoreDeadLinks?: boolean | 'localhostLinks'
 
   /**
    * @experimental

diff --git a/src/node/markdownToVue.ts b/src/node/markdownToVue.ts
@@ -115,7 +115,10 @@ export async function createMarkdownToVueRenderFn(
       for (let url of links) {
         if (/\.(?!html|md)\w+($|\?)/i.test(url)) continue
 
-        if (url.replace(EXTERNAL_URL_RE, '').startsWith('//localhost:')) {
+        if (
+          siteConfig?.ignoreDeadLinks !== 'localhostLinks' &&
+          url.replace(EXTERNAL_URL_RE, '').startsWith('//localhost:')
+        ) {
           recordDeadLink(url)
           continue
         }