@vuepress/markdown 2.0.0-rc.0 → 2.0.0-rc.10

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018-present, Yuxi (Evan) You
+Copyright (c) 2018-present, VuePress Community
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -0,0 +1,12 @@
+# @vuepress/markdown
+
+[![npm](https://badgen.net/npm/v/@vuepress/markdown/next)](https://www.npmjs.com/package/@vuepress/markdown)
+[![license](https://badgen.net/github/license/vuepress/core)](https://github.com/vuepress/core/blob/main/LICENSE)
+
+## Documentation
+
+https://v2.vuepress.vuejs.org
+
+## License
+
+[MIT](https://github.com/vuepress/core/blob/main/LICENSE)

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import { SfcPluginOptions } from '@mdit-vue/plugin-sfc';
 export { MarkdownSfcBlocks, SfcPluginOptions, sfcPlugin } from '@mdit-vue/plugin-sfc';
 import { MarkdownItEnv } from '@mdit-vue/types';
 import { PageHeader, PageFrontmatter } from '@vuepress/shared';
-import MarkdownIt, { PluginWithOptions } from 'markdown-it';
+import MarkdownIt, { PluginWithOptions, Options as Options$1 } from 'markdown-it';
 import { FrontmatterPluginOptions } from '@mdit-vue/plugin-frontmatter';
 export { FrontmatterPluginOptions, frontmatterPlugin } from '@mdit-vue/plugin-frontmatter';
 import { HeadersPluginOptions } from '@mdit-vue/plugin-headers';
@@ -11,14 +11,18 @@ import { TocPluginOptions } from '@mdit-vue/plugin-toc';
 export { TocPluginOptions, tocPlugin } from '@mdit-vue/plugin-toc';
 import anchorPlugin from 'markdown-it-anchor';
 export { default as anchorPlugin } from 'markdown-it-anchor';
-import emojiPlugin from 'markdown-it-emoji';
-export { default as emojiPlugin } from 'markdown-it-emoji';
+import { Options } from 'markdown-it-emoji';
+export { full as emojiPlugin } from 'markdown-it-emoji';
 export { ComponentPluginOptions, componentPlugin } from '@mdit-vue/plugin-component';
 export { titlePlugin } from '@mdit-vue/plugin-title';
 
 type AnchorPluginOptions = anchorPlugin.AnchorOptions;
 
 interface AssetsPluginOptions {
+    /**
+     * Whether to prepend base to absolute path
+     */
+    absolutePathPrependBase?: boolean;
     /**
      * Prefix to add to relative assets links
      */
@@ -47,7 +51,7 @@ interface CodePluginOptions {
      *
      * - Required for `highlightLines`
      * - Required for `lineNumbers`
-     * - Required for language display of default theme
+     * - Required for title display of default theme
      */
     preWrapper?: boolean;
     /**
@@ -69,7 +73,7 @@ interface CodePluginOptions {
  */
 declare const codePlugin: PluginWithOptions<CodePluginOptions>;
 
-type EmojiPluginOptions = emojiPlugin.Options;
+type EmojiPluginOptions = Options;
 
 interface ImportCodePluginOptions {
     /**
@@ -83,9 +87,9 @@ interface LinksPluginOptions {
     /**
      * Tag for internal links
      *
-     * @default 'RouterLink'
+     * @default 'RouteLink'
      */
-    internalTag?: 'a' | 'RouterLink';
+    internalTag?: 'a' | 'RouteLink' | 'RouterLink';
     /**
      * Additional attributes for external links
      *
@@ -102,14 +106,14 @@ interface LinksPluginOptions {
 /**
  * Process links in markdown file
  *
- * - internal links: convert them into `<RouterLink>`
- * - external links: add extra attrs and external icon
+ * - internal links: convert `<a>` tag into internalTag
+ * - external links: add extra attrs
  */
 declare const linksPlugin: PluginWithOptions<LinksPluginOptions>;
 
 type Markdown = MarkdownIt;
 
-interface MarkdownOptions extends MarkdownIt.Options {
+interface MarkdownOptions extends Options$1 {
     anchor?: false | AnchorPluginOptions;
     assets?: false | AssetsPluginOptions;
     code?: false | CodePluginOptions;
@@ -136,7 +140,7 @@ type MarkdownHeader = PageHeader;
 interface MarkdownLink {
     raw: string;
     relative: string;
-    absolute: string;
+    absolute: string | null;
 }
 /**
  * The `env` object to be passed to markdown-it render function
@@ -181,4 +185,4 @@ type MarkdownSlugifyFunction = (str: string) => string;
  */
 declare const createMarkdown: ({ anchor, assets, code, component, emoji, frontmatter, headers, title, importCode, links, sfc, slugify, toc, ...markdownItOptions }?: MarkdownOptions) => Markdown;
 
-export { AnchorPluginOptions, AssetsPluginOptions, CodePluginOptions, EmojiPluginOptions, ImportCodePluginOptions, LinksPluginOptions, Markdown, MarkdownEnv, MarkdownHeader, MarkdownLink, MarkdownOptions, MarkdownSlugifyFunction, assetsPlugin, codePlugin, createMarkdown, importCodePlugin, linksPlugin };
+export { type AnchorPluginOptions, type AssetsPluginOptions, type CodePluginOptions, type EmojiPluginOptions, type ImportCodePluginOptions, type LinksPluginOptions, type Markdown, type MarkdownEnv, type MarkdownHeader, type MarkdownLink, type MarkdownOptions, type MarkdownSlugifyFunction, assetsPlugin, codePlugin, createMarkdown, importCodePlugin, linksPlugin };

package/dist/index.js

@@ -28,7 +28,12 @@ import { default as anchorPlugin } from "markdown-it-anchor";
 // src/plugins/assetsPlugin/resolveLink.ts
 import { path } from "@vuepress/utils";
 import { decode } from "mdurl";
-var resolveLink = (link, relativePathPrefix, env, strict = false) => {
+var resolveLink = (link, {
+  env,
+  absolutePathPrependBase = false,
+  relativePathPrefix,
+  strict = false
+}) => {
   if (link.startsWith("data:"))
     return link;
   let resolvedLink = decode(link);
@@ -45,40 +50,49 @@ var resolveLink = (link, relativePathPrefix, env, strict = false) => {
       resolvedLink
     )}`;
   }
+  if (absolutePathPrependBase && env.base && link.startsWith("/")) {
+    resolvedLink = path.join(env.base, resolvedLink);
+  }
   return resolvedLink;
 };
 
 // src/plugins/assetsPlugin/assetsPlugin.ts
-var assetsPlugin = (md, { relativePathPrefix = "@source" } = {}) => {
+var assetsPlugin = (md, {
+  absolutePathPrependBase = false,
+  relativePathPrefix = "@source"
+} = {}) => {
   const rawImageRule = md.renderer.rules.image;
   md.renderer.rules.image = (tokens, idx, options, env, self) => {
     const token = tokens[idx];
     const link = token.attrGet("src");
     if (link) {
-      token.attrSet("src", resolveLink(link, relativePathPrefix, env));
+      token.attrSet(
+        "src",
+        resolveLink(link, { env, absolutePathPrependBase, relativePathPrefix })
+      );
     }
     return rawImageRule(tokens, idx, options, env, self);
   };
   const createHtmlRule = (rawHtmlRule) => (tokens, idx, options, env, self) => {
     tokens[idx].content = tokens[idx].content.replace(
       /(<img\b.*?src=)(['"])([^\2]*?)\2/gs,
-      (_, prefix, quote, src) => `${prefix}${quote}${resolveLink(
-        src.trim(),
-        relativePathPrefix,
+      (_, prefix, quote, src) => `${prefix}${quote}${resolveLink(src.trim(), {
         env,
-        true
-      )}${quote}`
+        absolutePathPrependBase,
+        relativePathPrefix,
+        strict: true
+      })}${quote}`
     ).replace(
       /(<img\b.*?srcset=)(['"])([^\2]*?)\2/gs,
       (_, prefix, quote, srcset) => `${prefix}${quote}${srcset.split(",").map(
         (item) => item.trim().replace(
           /^([^ ]*?)([ \n].*)?$/,
-          (_2, url, descriptor = "") => `${resolveLink(
-            url.trim(),
-            relativePathPrefix,
+          (_2, url, descriptor = "") => `${resolveLink(url.trim(), {
             env,
-            true
-          )}${descriptor.replace(/[ \n]+/g, " ").trimEnd()}`
+            absolutePathPrependBase,
+            relativePathPrefix,
+            strict: true
+          })}${descriptor.replace(/[ \n]+/g, " ").trimEnd()}`
         )
       ).join(", ")}${quote}`
     );
@@ -90,6 +104,14 @@ var assetsPlugin = (md, { relativePathPrefix = "@source" } = {}) => {
   md.renderer.rules.html_inline = createHtmlRule(rawHtmlInlineRule);
 };
 
+// src/plugins/codePlugin/resolveAttr.ts
+var resolveAttr = (info, attr) => {
+  const pattern = `\\b${attr}\\s*=\\s*(?<quote>['"])(?<content>.+?)\\k<quote>(\\s|$)`;
+  const regex = new RegExp(pattern, "i");
+  const match = info.match(regex);
+  return match?.groups?.content ?? null;
+};
+
 // src/plugins/codePlugin/resolveHighlightLines.ts
 var resolveHighlightLines = (info) => {
   const match = info.match(/{([\d,-]+)}/);
@@ -271,7 +293,8 @@ var codePlugin = (md, {
       const lineNumbersCode = lines.map(() => `<div class="line-number"></div>`).join("");
       result = `${result}<div class="line-numbers" aria-hidden="true">${lineNumbersCode}</div>`;
     }
-    result = `<div class="${languageClass}${useLineNumbers ? " line-numbers-mode" : ""}" data-ext="${language.ext}">${result}</div>`;
+    const title = resolveAttr(info, "title") ?? language.ext;
+    result = `<div class="${languageClass}${useLineNumbers ? " line-numbers-mode" : ""}" data-ext="${language.ext}" data-title="${title}">${result}</div>`;
     return result;
   };
   if (vPreInline) {
@@ -284,7 +307,7 @@ var codePlugin = (md, {
 };
 
 // src/plugins/emojiPlugin.ts
-import emojiPlugin from "markdown-it-emoji";
+import { full as emojiPlugin } from "markdown-it-emoji";
 
 // src/plugins/importCodePlugin/createImportCodeBlockRule.ts
 import { path as path2 } from "@vuepress/utils";
@@ -377,7 +400,7 @@ var importCodePlugin = (md, options = {}) => {
 };
 
 // src/plugins/linksPlugin/linksPlugin.ts
-import { isLinkExternal } from "@vuepress/shared";
+import { inferRoutePath, isLinkExternal } from "@vuepress/shared";
 
 // src/plugins/linksPlugin/resolvePaths.ts
 import { removeLeadingSlash } from "@vuepress/shared";
@@ -403,7 +426,7 @@ var resolvePaths = (rawPath, base, filePathRelative) => {
       absolutePath = path4.join(base, relativePath);
     } else {
       relativePath = rawPath.replace(/^(?:\.\/)?(.*)$/, "$1");
-      absolutePath = relativePath;
+      absolutePath = null;
     }
   }
   return {
@@ -414,7 +437,7 @@ var resolvePaths = (rawPath, base, filePathRelative) => {
 
 // src/plugins/linksPlugin/linksPlugin.ts
 var linksPlugin = (md, options = {}) => {
-  const internalTag = options.internalTag || "RouterLink";
+  const internalTag = options.internalTag || "RouteLink";
   const externalAttrs = {
     target: "_blank",
     rel: "noopener noreferrer",
@@ -437,25 +460,31 @@ var linksPlugin = (md, options = {}) => {
       return;
     }
     const internalLinkMatch = hrefLink.match(
-      /^((?:.*)(?:\/|\.md|\.html))(#.*)?$/
+      /^([^#?]*?(?:\/|\.md|\.html))([#?].*)?$/
     );
     if (!internalLinkMatch) {
       return;
     }
     const rawPath = internalLinkMatch[1];
-    const rawHash = internalLinkMatch[2] || "";
+    const rawHashAndQueries = internalLinkMatch[2] || "";
     const { relativePath, absolutePath } = resolvePaths(
       rawPath,
       base,
       filePathRelative
     );
-    const normalizedPath = absolutePath.replace(new RegExp(`^${base}`), "/").replace(/(^|\/)(README|index).md$/i, "$1").replace(/\.md$/, ".html");
-    if (internalTag === "RouterLink") {
+    if (["RouterLink", "RouteLink"].includes(internalTag)) {
       token.tag = internalTag;
       hrefAttr[0] = "to";
+      const normalizedPath = inferRoutePath(
+        absolutePath ? absolutePath.replace(new RegExp(`^${base}`), "/") : relativePath
+      );
+      hrefAttr[1] = `${normalizedPath}${rawHashAndQueries}`;
       hasOpenInternalLink = true;
+    } else {
+      const normalizedPath = inferRoutePath(absolutePath ?? relativePath);
+      hrefAttr[1] = `${normalizedPath}${rawHashAndQueries}`;
     }
-    hrefAttr[1] = `${normalizedPath}${rawHash}`;
+    ;
     (env.links ??= []).push({
       raw: hrefLink,
       relative: relativePath,
@@ -466,7 +495,7 @@ var linksPlugin = (md, options = {}) => {
     handleLinkOpen(tokens, idx, env);
     return self.renderToken(tokens, idx, options2);
   };
-  md.renderer.rules.link_close = (tokens, idx, options2, env, self) => {
+  md.renderer.rules.link_close = (tokens, idx, options2, _env, self) => {
     if (hasOpenInternalLink) {
       hasOpenInternalLink = false;
       tokens[idx].tag = internalTag;
@@ -501,11 +530,10 @@ var createMarkdown = ({
     md.use(anchorPlugin, {
       level: [1, 2, 3, 4, 5, 6],
       slugify,
-      permalink: anchorPlugin.permalink.ariaHidden({
+      permalink: anchorPlugin.permalink.headerLink({
         class: "header-anchor",
-        symbol: "#",
-        space: true,
-        placement: "before"
+        // Add a span inside the link so Safari shows headings in reader view.
+        safariReaderFix: true
       }),
       ...anchor
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/markdown",
-  "version": "2.0.0-rc.0",
+  "version": "2.0.0-rc.10",
   "description": "Markdown package of VuePress",
   "keywords": [
     "vuepress",
@@ -8,11 +8,11 @@
   ],
   "homepage": "https://github.com/vuepress",
   "bugs": {
-    "url": "https://github.com/vuepress/vuepress-next/issues"
+    "url": "https://github.com/vuepress/core/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/vuepress/vuepress-next.git"
+    "url": "git+https://github.com/vuepress/core.git"
   },
   "license": "MIT",
   "author": "meteorlxy",
@@ -27,25 +27,25 @@
     "dist"
   ],
   "dependencies": {
-    "@mdit-vue/plugin-component": "^1.0.0",
-    "@mdit-vue/plugin-frontmatter": "^1.0.0",
-    "@mdit-vue/plugin-headers": "^1.0.0",
-    "@mdit-vue/plugin-sfc": "^1.0.0",
-    "@mdit-vue/plugin-title": "^1.0.0",
-    "@mdit-vue/plugin-toc": "^1.0.0",
-    "@mdit-vue/shared": "^1.0.0",
-    "@mdit-vue/types": "^1.0.0",
-    "@types/markdown-it": "^13.0.6",
-    "@types/markdown-it-emoji": "^2.0.4",
-    "markdown-it": "^13.0.2",
+    "@mdit-vue/plugin-component": "^2.1.3",
+    "@mdit-vue/plugin-frontmatter": "^2.1.3",
+    "@mdit-vue/plugin-headers": "^2.1.3",
+    "@mdit-vue/plugin-sfc": "^2.1.3",
+    "@mdit-vue/plugin-title": "^2.1.3",
+    "@mdit-vue/plugin-toc": "^2.1.3",
+    "@mdit-vue/shared": "^2.1.3",
+    "@mdit-vue/types": "^2.1.0",
+    "@types/markdown-it": "^14.1.1",
+    "@types/markdown-it-emoji": "^3.0.1",
+    "markdown-it": "^14.1.0",
     "markdown-it-anchor": "^8.6.7",
-    "markdown-it-emoji": "^2.0.2",
-    "mdurl": "^1.0.1",
-    "@vuepress/shared": "2.0.0-rc.0",
-    "@vuepress/utils": "2.0.0-rc.0"
+    "markdown-it-emoji": "^3.0.0",
+    "mdurl": "^2.0.0",
+    "@vuepress/shared": "2.0.0-rc.10",
+    "@vuepress/utils": "2.0.0-rc.10"
   },
   "devDependencies": {
-    "@types/mdurl": "^1.0.5"
+    "@types/mdurl": "^2.0.0"
   },
   "publishConfig": {
     "access": "public"
@@ -62,7 +62,7 @@
     "outDir": "./dist",
     "sourcemap": false,
     "target": "es2022",
-    "tsconfig": "../tsconfig.dts.json"
+    "tsconfig": "../../tsconfig.dts.json"
   },
   "scripts": {
     "build": "tsup",