fix(markdown): keep base if link tag is not updated

Author: meteorlxy

packages/markdown/src/plugins/linksPlugin/linksPlugin.ts

@@ -29,8 +29,8 @@ export interface LinksPluginOptions {
 /**
  * Process links in markdown file
  *
- * - internal links: convert them into `<VPLink>`
- * - external links: add extra attrs and external icon
+ * - internal links: convert `<a>` tag into internalTag
+ * - external links: add extra attrs
  */
 export const linksPlugin: PluginWithOptions<LinksPluginOptions> = (
   md,
@@ -106,28 +106,26 @@ export const linksPlugin: PluginWithOptions<LinksPluginOptions> = (
       filePathRelative,
     )
 
-    // normalize markdown file path to route path
-    //
-    // we are removing the `base` from absolute path because it should not be
-    // passed to `<VPLink>`
-    //
-    // '/foo/index.md' => '/foo/'
-    // '/foo/bar.md' => '/foo/bar.html'
-    const normalizedPath = normalizeRoutePath(
-      absolutePath.replace(new RegExp(`^${base}`), '/'),
-    )
-
     if (['RouterLink', 'VPLink'].includes(internalTag)) {
       // convert starting tag of internal link to `internalTag`
       token.tag = internalTag
       // replace the original `href` attr with `to` attr
       hrefAttr[0] = 'to'
+      // normalize markdown file path to route path
+      // we are removing the `base` from absolute path because it should not be
+      // passed to `<VPLink>` or `<RouterLink>`
+      const normalizedPath = normalizeRoutePath(
+        absolutePath.replace(new RegExp(`^${base}`), '/'),
+      )
+      // replace the original href link with the normalized path
+      hrefAttr[1] = `${normalizedPath}${rawHash}`
       // set `hasOpenInternalLink` to modify the ending tag
       hasOpenInternalLink = true
+    } else {
+      const normalizedPath = normalizeRoutePath(absolutePath)
+      hrefAttr[1] = `${normalizedPath}${rawHash}`
     }
 
-    hrefAttr[1] = `${normalizedPath}${rawHash}`
-
     // extract internal links for file / page existence check
     ;(env.links ??= []).push({
       raw: hrefLink,

packages/markdown/src/plugins/linksPlugin/resolvePaths.ts

@@ -15,27 +15,25 @@ export const resolvePaths = (
   let absolutePath: string
   let relativePath: string
 
+  // if raw path is absolute
   if (rawPath.startsWith('/')) {
-    // if raw path is absolute
-
+    // if raw path is a link to markdown file
     if (rawPath.endsWith('.md')) {
-      // if raw path is a link to markdown file
-
       // prepend `base` to the link
       absolutePath = path.join(base, rawPath)
       relativePath = removeLeadingSlash(rawPath)
-    } else {
-      // if raw path is a link to other kind of file
-
+    }
+    // if raw path is a link to other kind of file
+    else {
       // keep the link as is
       absolutePath = rawPath
       relativePath = path.relative(base, absolutePath)
     }
-  } else {
-    // if raw path is relative
+  }
+  // if raw path is relative
+  else {
+    // if `filePathRelative` is available
     if (filePathRelative) {
-      // if `filePathRelative` is available
-
       // resolve relative path according to `filePathRelative`
       relativePath = path.join(
         // file path may contain non-ASCII characters
@@ -44,9 +42,9 @@ export const resolvePaths = (
       )
       // resolve absolute path according to `base`
       absolutePath = path.join(base, relativePath)
-    } else {
-      // if `filePathRelative` is not available
-
+    }
+    // if `filePathRelative` is not available
+    else {
       // remove leading './'
       relativePath = rawPath.replace(/^(?:\.\/)?(.*)$/, '$1')
       // just take relative link as absolute link

packages/markdown/tests/plugins/linksPlugin.spec.ts

@@ -838,6 +838,45 @@ describe('@vuepress/markdown > plugins > linksPlugin', () => {
           },
         ])
       })
+
+      it('should render to <a> tag correctly', () => {
+        const md = MarkdownIt({ html: true }).use(linksPlugin, {
+          internalTag: 'a',
+        })
+        const env: MarkdownEnv = {
+          base: '/base/',
+        }
+
+        const rendered = md.render(source, env)
+
+        expect(rendered).toEqual(
+          [
+            '<a href="/base/path/to/">md</a>',
+            '<a href="/base/base/path/to/">md-with-redundant-base</a>',
+            '<a href="/base/path/to/">html</a>',
+          ]
+            .map((a) => `<p>${a}</p>`)
+            .join('\n') + '\n',
+        )
+
+        expect(env.links).toEqual([
+          {
+            raw: '/path/to/index.md',
+            relative: 'path/to/index.md',
+            absolute: '/base/path/to/index.md',
+          },
+          {
+            raw: '/base/path/to/index.md',
+            relative: 'base/path/to/index.md',
+            absolute: '/base/base/path/to/index.md',
+          },
+          {
+            raw: '/base/path/to/index.html',
+            relative: 'path/to/index.html',
+            absolute: '/base/path/to/index.html',
+          },
+        ])
+      })
     })
   })