vitepress-plugin-toolkit 0.3.0 → 0.5.0

package/dist/node/index.d.ts

@@ -1,37 +1,127 @@
+import { Matcher } from "picomatch";
 import MarkdownIt from "markdown-it";
 import { RenderRule } from "markdown-it/lib/renderer.mjs";
-import { RuleOptions } from "markdown-it/lib/ruler.mjs";
 import { MarkdownEnv, Plugin, SiteConfig } from "vitepress";
 
 //#region src/shared/link.d.ts
+/**
+ * Regular expression that matches external URLs.
+ *
+ * Matches URLs that start with a protocol (such as `http:` or `mailto:`) or
+ * with `//` (protocol-relative URLs).
+ *
+ * 匹配外部链接的正则表达式。
+ *
+ * 匹配以协议（如 `http:` 或 `mailto:`）或 `//`（协议相对链接）开头的 URL。
+ *
+ * @example
+ * EXTERNAL_URL_RE.test('https://example.com') // true
+ * EXTERNAL_URL_RE.test('//cdn.example.com/lib.js') // true
+ * EXTERNAL_URL_RE.test('/about') // false
+ */
 declare const EXTERNAL_URL_RE: RegExp;
+/**
+ * Checks whether the given path is an external URL.
+ *
+ * 判断给定路径是否为外部链接。
+ *
+ * @param path - The path to check / 要检查的路径
+ * @returns `true` if the path is an external URL, otherwise `false` / 若为外部链接返回 `true`，否则返回 `false`
+ * @example
+ * isExternal('https://example.com') // true
+ * isExternal('//cdn.example.com/lib.js') // true
+ * isExternal('/about') // false
+ * isExternal('mailto:foo@example.com') // true
+ */
 declare function isExternal(path: string): boolean;
+/**
+ * Regular expression that matches the protocol scheme of a URL.
+ *
+ * Matches the leading protocol portion such as `http:`, `https:`, or
+ * `mailto:`. Does not match protocol-relative URLs (`//`).
+ *
+ * 匹配 URL 协议部分的正则表达式。
+ *
+ * 匹配前导协议部分，如 `http:`、`https:` 或 `mailto:`。
+ * 不匹配协议相对链接（`//`）。
+ *
+ * @example
+ * URL_PROTOCOL_RE.test('https://example.com') // true
+ * URL_PROTOCOL_RE.test('mailto:foo@example.com') // true
+ * URL_PROTOCOL_RE.test('//cdn.example.com/lib.js') // false
+ */
 declare const URL_PROTOCOL_RE: RegExp;
+/**
+ * Checks whether the given link contains a URL protocol scheme or is a
+ * protocol-relative URL.
+ *
+ * Unlike {@link isExternal}, this function also matches links that start with
+ * `//` via an additional check, in addition to those matched by
+ * {@link URL_PROTOCOL_RE}.
+ *
+ * 判断给定链接是否包含 URL 协议部分或为协议相对链接。
+ *
+ * 与 {@link isExternal} 不同，此函数除了匹配 {@link URL_PROTOCOL_RE} 之外，
+ * 还会通过额外检查匹配以 `//` 开头的链接。
+ *
+ * @param link - The link to check / 要检查的链接
+ * @returns `true` if the link has a protocol or starts with `//` / 若链接包含协议或以 `//` 开头则返回 `true`
+ * @example
+ * isLinkWithProtocol('https://example.com') // true
+ * isLinkWithProtocol('mailto:foo@example.com') // true
+ * isLinkWithProtocol('//cdn.example.com/lib.js') // true
+ * isLinkWithProtocol('/about') // false
+ */
 declare function isLinkWithProtocol(link: string): boolean;
 //#endregion
 //#region src/shared/size.d.ts
 /**
- * Size Options
+ * Options for describing the size of an element.
+ *
+ * Used by plugins to normalize width, height, and aspect ratio inputs into a
+ * consistent CSS-friendly form.
+ *
+ * 描述元素尺寸的选项。
+ *
+ * 供插件使用，将宽度、高度和宽高比输入归一化为一致的 CSS 友好形式。
  *
- * 尺寸选项
+ * @example
+ * const options: SizeOptions = {
+ *   width: '100%',
+ *   ratio: 16 / 9,
+ * }
  */
 interface SizeOptions {
   /**
-   * Width
+   * Width of the element, expressed as a CSS value.
+   *
+   * 元素的宽度，以 CSS 值表示。
    *
-   * 宽度
+   * @example
+   * '100%' | '640px' | 'auto'
    */
   width?: string;
   /**
-   * Height
+   * Height of the element, expressed as a CSS value.
+   *
+   * 元素的高度，以 CSS 值表示。
    *
-   * 高度
+   * @example
+   * '100%' | '360px' | 'auto'
    */
   height?: string;
   /**
-   * Aspect ratio
+   * Aspect ratio of the element. Can be:
+   *   - `number`: Numeric ratio (for example `16 / 9` represents 16:9)
+   *   - `string`: CSS aspect-ratio value (for example `'16 / 9'` or `'1.77'`)
    *
-   * 宽高比
+   * 元素的宽高比。可以是：
+   *   - `number`：数字比例（例如 `16 / 9` 表示 16:9）
+   *   - `string`：CSS aspect-ratio 值（例如 `'16 / 9'` 或 `'1.77'`）
+   *
+   * @example
+   * 16 / 9
+   * '16 / 9'
    */
   ratio?: number | string;
 }
@@ -72,6 +162,13 @@ interface ContainerOptions {
  * @param options - Optional before/after render hooks / 可选的 before/after 渲染钩子
  * @param options.before - Callback for rendering container opening tag / 渲染容器起始标签时的回调函数
  * @param options.after - Callback for rendering container closing tag / 渲染容器结束标签时的回调函数
+ * @example
+ * ```ts
+ * md.use(createContainerPlugin, 'tip', {
+ *   before: info => `<div class="tip">${info}`,
+ *   after: () => '</div>',
+ * })
+ * ```
  */
 declare function createContainerPlugin(md: MarkdownIt, type: string, {
   before,
@@ -122,43 +219,25 @@ interface EmbedRuleBlockOptions<Meta extends Record<string, any>> {
    */
   name?: string;
   /**
-   * Name of the rule to insert before
-   *
-   * 要插入在其前面的规则名称
-   */
-  beforeName?: string;
-  /**
-   * Syntax pattern regular expression
+   * Parse the `info` and `source` in `@[type info](source)` and convert them into a metadata object.
    *
-   * 语法模式正则表达式
-   */
-  syntaxPattern: RegExp;
-  /**
-   * Rule options
-   *
-   * 规则选项
-   */
-  ruleOptions?: RuleOptions;
-  /**
-   * Extract metadata from match
+   * 解析 `@[type info](source)` 中的 `info` 和 `source`，转换为元数据对象
    *
-   * 从匹配中提取元数据
-   *
-   * @param match - RegExp match array / 正则表达式匹配数组
+   * @param info - Information / 信息
+   * @param source - Source / 来源
    * @returns Metadata object / 元数据对象
    */
-  meta: (match: RegExpMatchArray) => Meta;
+  meta: (info: string, source: string) => Meta;
   /**
    * Generate content from metadata
    *
    * 从元数据生成内容
    *
    * @param meta - Metadata / 元数据
-   * @param content - Original content / 原始内容
    * @param env - Markdown environment / Markdown 环境
    * @returns Generated content / 生成的内容
    */
-  content: (meta: Meta, content: string, env: MarkdownEnv) => string;
+  content?: (meta: Meta, env: MarkdownEnv) => string;
 }
 /**
  * Create embed rule block
@@ -172,38 +251,118 @@ interface EmbedRuleBlockOptions<Meta extends Record<string, any>> {
  * @param md - Markdown instance / Markdown 实例
  * @param {EmbedRuleBlockOptions} options - Embed rule block options / 嵌入规则块选项
  * @typeParam Meta - Metadata type / 元数据类型
+ * @example
+ * ```ts
+ * createEmbedRuleBlock(md, {
+ *   type: 'video',
+ *   meta: (info, source) => ({ src: source, title: info }),
+ *   content: meta => `<video src="${meta.src}" title="${meta.title}"></video>`,
+ * })
+ * ```
  */
 declare function createEmbedRuleBlock<Meta extends Record<string, any> = Record<string, any>>(md: MarkdownIt, {
   type,
   name,
-  syntaxPattern,
-  beforeName,
-  ruleOptions,
   meta,
   content
 }: EmbedRuleBlockOptions<Meta>): void;
 //#endregion
 //#region src/node/utils/constants.d.ts
+/**
+ * Whether the current process is running in production build mode.
+ *
+ * 当前进程是否运行在生产构建模式下。
+ */
 declare const isBuild: boolean;
+/**
+ * Whether the current process is running in development mode.
+ *
+ * 当前进程是否运行在开发模式下。
+ */
 declare const isDev: boolean;
 /**
- * 浏览器支持的视频文件名扩展名
+ * Browser-supported video file name extensions.
+ *
+ * 浏览器支持的视频文件名扩展名。
  */
 declare const EXTENSION_VIDEOS: string[];
 /**
- * 浏览器支持的图片文件名扩展名
+ * Browser-supported image file name extensions.
+ *
+ * 浏览器支持的图片文件名扩展名。
  */
 declare const EXTENSION_IMAGES: string[];
 /**
- * 浏览器支持的音频文件名扩展名
+ * Browser-supported audio file name extensions.
+ *
+ * 浏览器支持的音频文件名扩展名。
  */
 declare const EXTENSION_AUDIOS: string[];
 //#endregion
+//#region src/node/utils/createMatcher.d.ts
+/**
+ * Create a matcher for the given include and exclude patterns.
+ *
+ * 创建一个用于给定 include 和 exclude 模式的匹配器。
+ *
+ * @param include - Patterns to include, can be string or array / 要包含的模式，可以是字符串或数组
+ * @param exclude - Patterns to exclude, can be string or array / 要排除的模式，可以是字符串或数组
+ * @returns Matcher instance / 匹配器实例
+ */
+declare function createMatcher(include?: string | string[], exclude?: string | string[]): Matcher | undefined;
+/**
+ * Resolve include and exclude patterns into pattern and ignore arrays.
+ * Converts various pattern formats into a standardized format for matching.
+ *
+ * 将 include 和 exclude 模式解析为 pattern 和 ignore 数组。
+ * 将各种模式格式转换为用于匹配的标准化格式。
+ *
+ * @param include - Patterns to include, can be string or array / 要包含的模式，可以是字符串或数组
+ * @param exclude - Patterns to exclude, can be string or array / 要排除的模式，可以是字符串或数组
+ * @returns Object containing pattern and ignore arrays / 包含 pattern 和 ignore 数组的对象
+ */
+declare function resolveMatcherPattern(include?: string | string[], exclude?: string | string[]): {
+  pattern: string[];
+  ignore: string[];
+};
+//#endregion
 //#region src/node/utils/hash.d.ts
+/**
+ * Generate a SHA-256 hash from the given data.
+ *
+ * 根据给定数据生成 SHA-256 哈希值。
+ *
+ * Primitive values are converted to strings directly, while objects are serialized
+ * to JSON before hashing. When `length` is provided, the hash is truncated to the
+ * specified length.
+ *
+ * 基本类型直接转为字符串，对象则序列化为 JSON 后再哈希。提供 `length` 时，
+ * 哈希值会被截断到指定长度。
+ *
+ * @param data - The data to hash, can be any value / 要哈希的数据，可以是任意值
+ * @param length - Optional length to truncate the hash / 可选的哈希值截断长度
+ * @returns The SHA-256 hash string (truncated if length is given)
+ *   / SHA-256 哈希字符串（指定长度时会被截断）
+ * @example
+ * ```ts
+ * genHash('hello') // full sha256 hash
+ * genHash({ a: 1 }, 8) // 8-character hash
+ * ```
+ */
 declare function genHash(data: unknown, length?: number): string;
 //#endregion
 //#region src/node/utils/logger.d.ts
+/**
+ * Log type for categorizing log messages.
+ *
+ * 用于分类日志消息的日志类型。
+ */
 type LogType = 'info' | 'warn' | 'error' | 'debug';
+/**
+ * Log level controlling the verbosity of the logger.
+ *
+ * 控制日志输出详细程度的日志级别。
+ */
 type LogLevel = LogType | 'silent';
 /**
  * Logger interface
@@ -250,6 +409,13 @@ declare const logLevels: Record<LogLevel, number>;
  * @param prefix - Log prefix / 日志前缀
  * @param defaultLevel - Default log level / 默认日志级别
  * @returns Logger instance / 日志实例
+ * @example
+ * ```ts
+ * const logger = createLogger('my-plugin', 'info')
+ * logger.info('Starting build')
+ * logger.warn('Deprecated feature used')
+ * logger.debug('Verbose details', 'debug')
+ * ```
  */
 declare function createLogger(prefix: string, defaultLevel?: LogLevel): Logger;
 //#endregion
@@ -262,6 +428,12 @@ declare function createLogger(prefix: string, defaultLevel?: LogLevel): Logger;
  * @param str - Size string / 尺寸字符串
  * @param unit - Unit to append (default: 'px') / 要添加的单位（默认：'px'）
  * @returns Size string with unit / 带单位的尺寸字符串
+ * @example
+ * ```ts
+ * parseRect('100') // '100px'
+ * parseRect('50%') // '50%'
+ * parseRect('200', 'rpx') // '200rpx'
+ * ```
  */
 declare function parseRect(str: string, unit?: string): string;
 //#endregion
@@ -274,6 +446,13 @@ declare function parseRect(str: string, unit?: string): string;
  * @param info - Attribute string / 属性字符串
  * @returns Object with attrs and rawAttrs / 包含 attrs 和 rawAttrs 的对象
  * @typeParam T - Attribute type / 属性类型
+ * @example
+ * ```ts
+ * resolveAttrs('width="100" height="50"')
+ * // { width: '100', height: '50' }
+ * resolveAttrs('disabled title="Hello"')
+ * // { disabled: true, title: 'Hello' }
+ * ```
  */
 declare function resolveAttrs<T extends Record<string, any> = Record<string, any>>(info: string): T;
 /**
@@ -284,12 +463,35 @@ declare function resolveAttrs<T extends Record<string, any> = Record<string, any
  * @param info - Info string / 信息字符串
  * @param key - Attribute key / 属性键
  * @returns Attribute value or undefined / 属性值或 undefined
+ * @example
+ * ```ts
+ * resolveAttr('width="100" height="50"', 'width') // '100'
+ * resolveAttr('width="100" height="50"', 'color') // undefined
+ * ```
  */
 declare function resolveAttr(info: string, key: string): string | undefined;
 //#endregion
 //#region src/node/utils/slugify.d.ts
 /**
- * Default slugification function
+ * Default slugification function that normalizes a string into a URL-safe slug.
+ *
+ * 默认的 slug 化函数，将字符串规范化为 URL 安全的 slug。
+ *
+ * The function removes accents, control characters, and special characters,
+ * replaces separators with hyphens, and ensures the result does not start
+ * with a number.
+ *
+ * 该函数会移除重音符号、控制字符和特殊字符，用连字符替换分隔符，
+ * 并确保结果不以数字开头。
+ *
+ * @param str - The string to slugify / 要 slug 化的字符串
+ * @returns The slugified string / slug 化后的字符串
+ * @example
+ * ```ts
+ * slugify('Hello World!') // 'hello-world'
+ * slugify('你好 World') // '你好-world'
+ * slugify('1st Section') // '_1st-section'
+ * ```
  */
 declare function slugify(str: string): string;
 //#endregion
@@ -304,41 +506,214 @@ declare function slugify(str: string): string;
  * @param forceStringify - Keys to force stringify / 强制字符串化的键
  * @returns HTML attribute string / HTML 属性字符串
  * @typeParam T - Attribute type / 属性类型
+ * @example
+ * ```ts
+ * stringifyAttrs({ width: 100, disabled: true })
+ * // ' :width="100" disabled'
+ * stringifyAttrs({ title: 'hello', visible: false })
+ * // ' title="hello"'
+ * ```
  */
 declare function stringifyAttrs<T extends object = object>(attrs: T, withUndefinedOrNull?: boolean, forceStringify?: (keyof T)[]): string;
 //#endregion
 //#region src/node/utils/treat-as-html.d.ts
+/**
+ * Determine whether a file should be treated as an HTML route based on its extension.
+ *
+ * 根据文件扩展名判断该文件是否应作为 HTML 路由处理。
+ *
+ * Returns `true` when the file has no extension or its extension is not in the
+ * known extensions list (meaning it should be served as an HTML page). Returns
+ * `false` for known static asset extensions.
+ *
+ * 当文件没有扩展名或其扩展名不在已知扩展名列表中时返回 `true`（表示应作为
+ * HTML 页面提供）。对于已知的静态资源扩展名返回 `false`。
+ *
+ * @param filename - The filename to check / 要检查的文件名
+ * @returns `true` if the file should be treated as HTML, `false` otherwise
+ *   / 如果文件应作为 HTML 处理则返回 `true`，否则返回 `false`
+ * @example
+ * ```ts
+ * treatAsHtml('about') // true (no extension)
+ * treatAsHtml('logo.png') // false (known image extension)
+ * treatAsHtml('custom.xyz') // true (unknown extension)
+ * ```
+ */
 declare function treatAsHtml(filename: string): boolean;
 //#endregion
 //#region src/node/vite-plugins/iconPlugin.d.ts
+/**
+ * Represents an SVG icon definition with optional classname.
+ *
+ * 表示一个 SVG 图标定义，包含可选的类名。
+ */
 interface Icon {
+  /**
+   * Icon name used as the CSS class identifier.
+   *
+   * 用作 CSS 类标识的图标名称。
+   */
   name: string;
+  /**
+   * SVG content for the icon.
+   *
+   * 图标的 SVG 内容。
+   */
   svg: string;
+  /**
+   * Optional classname override for the icon.
+   *
+   * 图标的可选类名覆盖。
+   */
   classname?: string;
 }
+/**
+ * Create a Vite plugin that registers SVG icons as CSS custom properties.
+ *
+ * 创建一个 Vite 插件，将 SVG 图标注册为 CSS 自定义属性。
+ *
+ * The plugin collects icons into a global list and exposes them through a
+ * virtual module `virtual:tuck-icons.css`. Each icon is rendered as a CSS
+ * rule that sets the `--icon` custom property on `.vpi-<name>` selectors.
+ *
+ * 该插件将图标收集到全局列表中，并通过虚拟模块 `virtual:tuck-icons.css`
+ * 暴露它们。每个图标被渲染为一条 CSS 规则，在 `.vpi-<name>` 选择器上
+ * 设置 `--icon` 自定义属性。
+ *
+ * @param icons - Array of icon definitions to register / 要注册的图标定义数组
+ * @returns A Vite plugin instance / Vite 插件实例
+ * @example
+ * ```ts
+ * import { iconPlugin } from 'vitepress-plugin-toolkit/node'
+ * icons: iconPlugin([
+ *   { name: 'github', svg: '<svg>...</svg>' },
+ *   { name: 'twitter', svg: '<svg>...</svg>' },
+ * ])
+ * ```
+ */
 declare function iconPlugin(icons: Icon[]): Plugin;
 //#endregion
 //#region src/node/vitepress/createLocales.d.ts
+/**
+ * A builtin locale entry pairing language codes with their locale data.
+ *
+ * 内置语言环境条目，将语言代码与对应的语言环境数据配对。
+ *
+ * @typeParam LocaleData - Locale data type / 语言环境数据类型
+ */
 type BuiltinLocale<LocaleData extends Record<string, unknown>> = [langCodes: string[], localeData: LocaleData];
+/**
+ * A list of builtin locale entries.
+ *
+ * 内置语言环境条目列表。
+ *
+ * @typeParam LocaleData - Locale data type / 语言环境数据类型
+ */
 type BuiltinLocales<LocaleData extends Record<string, unknown>> = BuiltinLocale<LocaleData>[];
 /**
- * 创建 locales
- * @param builtinLocales 内置的 locales
- * @param userLocales 用户的 locales
- * @returns locales
+ * Create a locales configuration by merging builtin locales with user locales.
+ *
+ * 通过合并内置语言环境与用户语言环境来创建语言环境配置。
+ *
+ * The function reads the VitePress locales config, matches each locale key
+ * (or its `lang` field) against the builtin locales, and falls back to the
+ * first builtin locale for the `root` entry when no match is found. User
+ * locales are deep-merged on top of the result.
+ *
+ * 该函数读取 VitePress 的语言环境配置，将每个语言环境键（或其 `lang` 字段）
+ * 与内置语言环境匹配，未匹配到时 `root` 条目回退到第一个内置语言环境。
+ * 用户语言环境会深度合并到结果之上。
+ *
+ * @param builtinLocales - Builtin locale entries / 内置语言环境条目
+ * @param userLocales - User-provided locale overrides / 用户提供的语言环境覆盖
+ * @returns Merged locales configuration / 合并后的语言环境配置
+ * @typeParam LocaleData - Locale data type / 语言环境数据类型
+ * @example
+ * ```ts
+ * const locales = createLocales(
+ *   [[['en', 'en-US'], { title: 'English' }], [['zh', 'zh-CN'], { title: '中文' }]],
+ *   { zh: { title: '我的站点' } },
+ * )
+ * ```
  */
 declare function createLocales<LocaleData extends Record<string, unknown>>(builtinLocales: BuiltinLocales<LocaleData>, userLocales?: Record<string, LocaleData>): Record<string, LocaleData>;
 //#endregion
 //#region src/node/vitepress/get-locale-with-path.d.ts
+/**
+ * Resolve the locale and language code for a given path.
+ *
+ * 解析给定路径对应的语言环境和语言代码。
+ *
+ * The function inspects the VitePress locales config and finds the locale key
+ * that the provided path starts with. When the matched key is `root`, the
+ * returned locale is an empty string. Returns empty strings for both fields
+ * when no locale matches.
+ *
+ * 该函数检查 VitePress 的语言环境配置，找到所提供路径以其开头的语言环境键。
+ * 当匹配的键为 `root` 时，返回的语言环境为空字符串。无匹配时两个字段均返回空字符串。
+ *
+ * @param path - The path to resolve / 要解析的路径
+ * @returns An object with `lang` and `locale` fields / 包含 `lang` 和 `locale` 字段的对象
+ * @example
+ * ```ts
+ * getLocaleWithPath('/zh/guide/') // { lang: 'zh-CN', locale: '/zh/' }
+ * getLocaleWithPath('/guide/') // { lang: 'en', locale: '' } (root locale)
+ * ```
+ */
 declare function getLocaleWithPath(path: string): {
   lang: string;
   locale: string;
 };
 //#endregion
 //#region src/node/vitepress/get-vitepress-config.d.ts
+/**
+ * Get the current VitePress site configuration from the global context.
+ *
+ * 从全局上下文获取当前的 VitePress 站点配置。
+ *
+ * VitePress stores its resolved `SiteConfig` on `globalThis.VITEPRESS_CONFIG`
+ * during the build and dev lifecycle. This helper reads that value and throws
+ * when it has not been initialized yet.
+ *
+ * VitePress 在构建和开发生命周期中将解析后的 `SiteConfig` 存储在
+ * `globalThis.VITEPRESS_CONFIG` 上。该辅助函数读取该值，未初始化时抛出错误。
+ *
+ * @returns The current VitePress site config / 当前的 VitePress 站点配置
+ * @throws {Error} When VITEPRESS_CONFIG is not initialized / VITEPRESS_CONFIG 未初始化时
+ * @example
+ * ```ts
+ * const config = getVitepressConfig()
+ * console.log(config.userConfig.title)
+ * ```
+ */
 declare function getVitepressConfig(): SiteConfig;
 //#endregion
 //#region src/node/vitepress/resolve-route-link.d.ts
+/**
+ * Resolve a markdown link to its final URL form based on VitePress routing rules.
+ *
+ * 根据 VitePress 路由规则将 markdown 链接解析为最终 URL 形式。
+ *
+ * External links are returned as-is. Absolute paths are prefixed with the
+ * site base. Hash links are slugified. Relative links to markdown files are
+ * transformed according to the `cleanUrls` setting (`.md` becomes `''` or
+ * `.html`), and `index.md` is collapsed to its directory.
+ *
+ * 外部链接原样返回。绝对路径添加站点 base 前缀。哈希链接进行 slug 化。
+ * 指向 markdown 文件的相对链接根据 `cleanUrls` 设置转换（`.md` 变为 `''`
+ * 或 `.html`），`index.md` 折叠为其所在目录。
+ *
+ * @param url - The raw URL from markdown content / markdown 内容中的原始 URL
+ * @param env - The markdown environment with routing context / 带路由上下文的 markdown 环境
+ * @returns The resolved URL / 解析后的 URL
+ * @example
+ * ```ts
+ * resolveRouteLink('./guide.md', { cleanUrls: false } as MarkdownEnv)
+ * // './guide.html'
+ * resolveRouteLink('/about/', {} as MarkdownEnv)
+ * // '/base/about/'
+ * ```
+ */
 declare function resolveRouteLink(url: string, env: MarkdownEnv): string;
 //#endregion
-export { BuiltinLocale, BuiltinLocales, ContainerOptions, EXTENSION_AUDIOS, EXTENSION_IMAGES, EXTENSION_VIDEOS, EXTERNAL_URL_RE, EmbedRuleBlockOptions, LogLevel, LogType, Logger, SizeOptions, URL_PROTOCOL_RE, createContainerPlugin, createContainerSyntaxPlugin, createEmbedRuleBlock, createLocales, createLogger, genHash, getLocaleWithPath, getVitepressConfig, iconPlugin, isBuild, isDev, isExternal, isLinkWithProtocol, logLevels, parseRect, resolveAttr, resolveAttrs, resolveRouteLink, slugify, stringifyAttrs, treatAsHtml };
+export { BuiltinLocale, BuiltinLocales, ContainerOptions, EXTENSION_AUDIOS, EXTENSION_IMAGES, EXTENSION_VIDEOS, EXTERNAL_URL_RE, EmbedRuleBlockOptions, LogLevel, LogType, Logger, SizeOptions, URL_PROTOCOL_RE, createContainerPlugin, createContainerSyntaxPlugin, createEmbedRuleBlock, createLocales, createLogger, createMatcher, genHash, getLocaleWithPath, getVitepressConfig, iconPlugin, isBuild, isDev, isExternal, isLinkWithProtocol, logLevels, parseRect, resolveAttr, resolveAttrs, resolveMatcherPattern, resolveRouteLink, slugify, stringifyAttrs, treatAsHtml };