vitepress-plugin-toolkit 0.4.0 → 0.6.0

package/dist/client/styles/transition/fade-in.css

@@ -2,7 +2,7 @@
 
 .fade-in-enter-active,
 .fade-in-leave-active {
-  transition: all var(--transition-duration) var(--transition-ease-in-out) !important;
+  transition: opacity var(--transition-duration) var(--transition-ease-in-out) !important;
 }
 
 .fade-in-enter-from,

package/dist/node/index.d.ts

@@ -1,7 +1,7 @@
 import { Matcher } from "picomatch";
+import { MarkdownEnv, Plugin, SiteConfig } from "vitepress";
 import MarkdownIt from "markdown-it";
 import { RenderRule } from "markdown-it/lib/renderer.mjs";
-import { MarkdownEnv, Plugin, SiteConfig } from "vitepress";
 
 //#region src/shared/link.d.ts
 /**
@@ -126,6 +126,58 @@ interface SizeOptions {
   ratio?: number | string;
 }
 //#endregion
+//#region src/node/markdown/clean-markdown-env.d.ts
+/**
+ * Clean Markdown Environment
+ *
+ * 清理后的 Markdown 环境
+ */
+interface CleanMarkdownEnv extends MarkdownEnv {
+  /**
+   * References
+   *
+   * 引用链接
+   */
+  references?: unknown;
+  /**
+   * Abbreviations
+   *
+   * 缩写词
+   */
+  abbreviations?: unknown;
+  /**
+   * Annotations
+   *
+   * 注释
+   */
+  annotations?: unknown;
+}
+declare const WHITE_KEYS_LIST: readonly ["cleanUrls", "path", "realPath", "relativePath", "localeIndex", "references", "abbreviations", "annotations"];
+type WhiteKeysListUnion = (typeof WHITE_KEYS_LIST)[number];
+/**
+ * Clean markdown environment for inline rendering.
+ *
+ * 清理 markdown 环境以用于行内渲染。
+ *
+ * When using `md.renderInline()` in custom renderers, some environment properties
+ * may cause issues. This function creates a clean environment object with only
+ * the necessary properties preserved.
+ *
+ * 在自定义渲染器中使用 `md.renderInline()` 时，某些环境属性可能会导致问题。
+ * 该函数创建一个只保留必要属性的干净环境对象。
+ *
+ * @param env - Markdown environment / Markdown 环境
+ * @param exclude - Keys to exclude / 要排除的键
+ * @returns Cleaned environment / 清理后的环境
+ *
+ * @example
+ * ```ts
+ * const cleanEnv = cleanMarkdownEnv(env)
+ * const rendered = md.renderInline(content, cleanEnv)
+ * ```
+ */
+declare function cleanMarkdownEnv(env: MarkdownEnv, exclude?: WhiteKeysListUnion[]): CleanMarkdownEnv;
+//#endregion
 //#region src/node/markdown/container.d.ts
 /**
  * Type for getting RenderRule parameters
@@ -309,7 +361,7 @@ declare const EXTENSION_AUDIOS: string[];
  * @param exclude - Patterns to exclude, can be string or array / 要排除的模式，可以是字符串或数组
  * @returns Matcher instance / 匹配器实例
  */
-declare function createMatcher(include?: string | string[], exclude?: string | string[]): Matcher | undefined;
+declare function createMatcher(include?: string | string[], exclude?: string | string[]): Matcher;
 /**
  * Resolve include and exclude patterns into pattern and ignore arrays.
  * Converts various pattern formats into a standardized format for matching.
@@ -716,4 +768,4 @@ declare function getVitepressConfig(): SiteConfig;
  */
 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, createMatcher, genHash, getLocaleWithPath, getVitepressConfig, iconPlugin, isBuild, isDev, isExternal, isLinkWithProtocol, logLevels, parseRect, resolveAttr, resolveAttrs, resolveMatcherPattern, resolveRouteLink, slugify, stringifyAttrs, treatAsHtml };
+export { BuiltinLocale, BuiltinLocales, CleanMarkdownEnv, ContainerOptions, EXTENSION_AUDIOS, EXTENSION_IMAGES, EXTENSION_VIDEOS, EXTERNAL_URL_RE, EmbedRuleBlockOptions, LogLevel, LogType, Logger, SizeOptions, URL_PROTOCOL_RE, cleanMarkdownEnv, createContainerPlugin, createContainerSyntaxPlugin, createEmbedRuleBlock, createLocales, createLogger, createMatcher, genHash, getLocaleWithPath, getVitepressConfig, iconPlugin, isBuild, isDev, isExternal, isLinkWithProtocol, logLevels, parseRect, resolveAttr, resolveAttrs, resolveMatcherPattern, resolveRouteLink, slugify, stringifyAttrs, treatAsHtml };

package/dist/node/index.js

@@ -1,5 +1,5 @@
 import container from "markdown-it-container";
-import { LRUCache, camelCase, deepMerge, isArray, isBoolean, isNull, isNumber, isPrimitive, isString, isUndefined, kebabCase, objectEntries, objectKeys, omit, slash, toArray, uniq } from "@pengzhanbo/utils";
+import { LRUCache, camelCase, deepMerge, isArray, isBoolean, isNull, isNumber, isPrimitive, isString, isUndefined, kebabCase, objectEntries, objectKeys, omit, removeTrailingSlash, slash, toArray, uniq } from "@pengzhanbo/utils";
 import ansis from "ansis";
 import process from "node:process";
 import picomatch from "picomatch";
@@ -79,6 +79,48 @@ function isLinkWithProtocol(link) {
 	return URL_PROTOCOL_RE.test(link) || link.startsWith("//");
 }
 //#endregion
+//#region src/node/markdown/clean-markdown-env.ts
+const WHITE_KEYS_LIST = [
+	"cleanUrls",
+	"path",
+	"realPath",
+	"relativePath",
+	"localeIndex",
+	"references",
+	"abbreviations",
+	"annotations"
+];
+/**
+* Clean markdown environment for inline rendering.
+*
+* 清理 markdown 环境以用于行内渲染。
+*
+* When using `md.renderInline()` in custom renderers, some environment properties
+* may cause issues. This function creates a clean environment object with only
+* the necessary properties preserved.
+*
+* 在自定义渲染器中使用 `md.renderInline()` 时，某些环境属性可能会导致问题。
+* 该函数创建一个只保留必要属性的干净环境对象。
+*
+* @param env - Markdown environment / Markdown 环境
+* @param exclude - Keys to exclude / 要排除的键
+* @returns Cleaned environment / 清理后的环境
+*
+* @example
+* ```ts
+* const cleanEnv = cleanMarkdownEnv(env)
+* const rendered = md.renderInline(content, cleanEnv)
+* ```
+*/
+function cleanMarkdownEnv(env, exclude = []) {
+	const result = {};
+	for (const key of WHITE_KEYS_LIST) {
+		if (exclude.includes(key)) continue;
+		result[key] = env[key];
+	}
+	return result;
+}
+//#endregion
 //#region src/node/utils/resolve-attrs.ts
 /**
 * Regular expression for matching attribute values
@@ -864,7 +906,7 @@ const indexRE = /(^|.*\/)index.md(.*)$/i;
 function resolveRouteLink(url, env) {
 	if (isExternal(url)) return url;
 	const config = getVitepressConfig();
-	if (url.startsWith("/")) return slash(config.site.base + url);
+	if (url.startsWith("/")) return slash(removeTrailingSlash(config.site.base) + url);
 	if (url.startsWith("#")) return decodeURI(normalizeHash(url));
 	const { pathname, protocol } = new URL(url, "http://a.com");
 	if (!url.startsWith("#") && protocol.startsWith("http") && treatAsHtml(pathname)) {
@@ -895,4 +937,4 @@ function normalizeHash(str) {
 	return str ? encodeURI(`#${slugify(decodeURI(str).slice(1))}`) : "";
 }
 //#endregion
-export { EXTENSION_AUDIOS, EXTENSION_IMAGES, EXTENSION_VIDEOS, EXTERNAL_URL_RE, 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 };
+export { EXTENSION_AUDIOS, EXTENSION_IMAGES, EXTENSION_VIDEOS, EXTERNAL_URL_RE, URL_PROTOCOL_RE, cleanMarkdownEnv, createContainerPlugin, createContainerSyntaxPlugin, createEmbedRuleBlock, createLocales, createLogger, createMatcher, genHash, getLocaleWithPath, getVitepressConfig, iconPlugin, isBuild, isDev, isExternal, isLinkWithProtocol, logLevels, parseRect, resolveAttr, resolveAttrs, resolveMatcherPattern, resolveRouteLink, slugify, stringifyAttrs, treatAsHtml };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vitepress-plugin-toolkit",
   "type": "module",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Development toolkit for vitepress plugins",
   "author": "pengzhanbo <q942450674@outlook.com> (https://github.com/pengzhanbo/)",
   "license": "MIT",