vitepress-plugin-code-collapse 0.3.0 → 0.4.0

package/dist/client/browser/index.d.ts

@@ -26,6 +26,24 @@ declare function setupCollapsedLines({
 }): void;
 //#endregion
 //#region src/client/index.d.ts
+/**
+ * Enhances the VitePress app with collapsed lines functionality.
+ *
+ * This function is automatically invoked by the `virtual:enhance-app` module
+ * when the plugin is registered. It sets up the click event listener that
+ * toggles the collapsed state of code blocks.
+ *
+ * 为 VitePress 应用增强折叠行功能。
+ *
+ * 此函数在插件注册时由 `virtual:enhance-app` 模块自动调用。
+ * 它设置点击事件监听器，用于切换代码块的折叠状态。
+ *
+ * @example
+ * // Usually called automatically via `virtual:enhance-app`.
+ * // To invoke manually:
+ * import { enhanceAppWithCollapsedLines } from 'vitepress-plugin-code-collapse/client'
+ * enhanceAppWithCollapsedLines()
+ */
 declare function enhanceAppWithCollapsedLines(): void;
 //#endregion
 export { enhanceAppWithCollapsedLines, setupCollapsedLines };

package/dist/client/browser/index.js

@@ -35,6 +35,24 @@ function setupCollapsedLines({ selector = "div[class*=\"language-\"].has-collaps
 }
 //#endregion
 //#region src/client/index.ts
+/**
+* Enhances the VitePress app with collapsed lines functionality.
+*
+* This function is automatically invoked by the `virtual:enhance-app` module
+* when the plugin is registered. It sets up the click event listener that
+* toggles the collapsed state of code blocks.
+*
+* 为 VitePress 应用增强折叠行功能。
+*
+* 此函数在插件注册时由 `virtual:enhance-app` 模块自动调用。
+* 它设置点击事件监听器，用于切换代码块的折叠状态。
+*
+* @example
+* // Usually called automatically via `virtual:enhance-app`.
+* // To invoke manually:
+* import { enhanceAppWithCollapsedLines } from 'vitepress-plugin-code-collapse/client'
+* enhanceAppWithCollapsedLines()
+*/
 function enhanceAppWithCollapsedLines() {
 	setupCollapsedLines();
 }

package/dist/client/ssr/index.d.ts

@@ -26,6 +26,24 @@ declare function setupCollapsedLines({
 }): void;
 //#endregion
 //#region src/client/index.d.ts
+/**
+ * Enhances the VitePress app with collapsed lines functionality.
+ *
+ * This function is automatically invoked by the `virtual:enhance-app` module
+ * when the plugin is registered. It sets up the click event listener that
+ * toggles the collapsed state of code blocks.
+ *
+ * 为 VitePress 应用增强折叠行功能。
+ *
+ * 此函数在插件注册时由 `virtual:enhance-app` 模块自动调用。
+ * 它设置点击事件监听器，用于切换代码块的折叠状态。
+ *
+ * @example
+ * // Usually called automatically via `virtual:enhance-app`.
+ * // To invoke manually:
+ * import { enhanceAppWithCollapsedLines } from 'vitepress-plugin-code-collapse/client'
+ * enhanceAppWithCollapsedLines()
+ */
 declare function enhanceAppWithCollapsedLines(): void;
 //#endregion
 export { enhanceAppWithCollapsedLines, setupCollapsedLines };

package/dist/client/ssr/index.js

@@ -34,6 +34,24 @@ function setupCollapsedLines({ selector = "div[class*=\"language-\"].has-collaps
 }
 //#endregion
 //#region src/client/index.ts
+/**
+* Enhances the VitePress app with collapsed lines functionality.
+*
+* This function is automatically invoked by the `virtual:enhance-app` module
+* when the plugin is registered. It sets up the click event listener that
+* toggles the collapsed state of code blocks.
+*
+* 为 VitePress 应用增强折叠行功能。
+*
+* 此函数在插件注册时由 `virtual:enhance-app` 模块自动调用。
+* 它设置点击事件监听器，用于切换代码块的折叠状态。
+*
+* @example
+* // Usually called automatically via `virtual:enhance-app`.
+* // To invoke manually:
+* import { enhanceAppWithCollapsedLines } from 'vitepress-plugin-code-collapse/client'
+* enhanceAppWithCollapsedLines()
+*/
 function enhanceAppWithCollapsedLines() {
 	setupCollapsedLines();
 }

package/dist/node/index.d.ts

@@ -2,6 +2,19 @@ import { PluginWithOptions } from "markdown-it";
 
 //#region src/node/plugin.d.ts
 /**
+ * VitePress plugin for collapsing code blocks that exceed a specified line count.
+ *
+ * Integrates markdown-it rendering (to inject collapse markers and CSS variables)
+ * with client-side setup (to handle click interactions for expanding/collapsing).
+ * Code blocks can be configured globally via plugin options or individually via
+ * `:collapsed-lines` directives in the code fence info string.
+ *
+ * VitePress 插件，用于折叠超过指定行数的代码块。
+ *
+ * 将 markdown-it 渲染（注入折叠标记和 CSS 变量）与客户端设置（处理展开/折叠的
+ * 点击交互）集成在一起。代码块可通过插件选项全局配置，或通过代码围栏信息字符串
+ * 中的 `:collapsed-lines` 指令单独配置。
+ *
  * @example
  * ```ts
  * import collapsedLines from 'vitepress-code-collapse'
@@ -37,13 +50,25 @@ type CollapsedLinesOptions = boolean | number | 'disable';
 //#endregion
 //#region src/node/markdown.d.ts
 /**
- * Add collapsed lines functionality to code blocks in markdown-it
+ * Adds collapsed lines functionality to code blocks in markdown-it.
  *
- * 为 markdown-it 中的代码块添加折叠行功能
+ * Wraps the default fence renderer to inject collapse markers and CSS variables
+ * when code blocks exceed a specified line count. The collapse behavior can be
+ * controlled globally via plugin options or per code block via `:collapsed-lines`
+ * directives in the code fence info string.
  *
- * @param md - MarkdownIt instance / MarkdownIt 实例
- * @param options - Plugin options / 插件选项
+ * 为 markdown-it 中的代码块添加折叠行功能。
+ *
+ * 包装默认的 fence 渲染器，当代码块超过指定行数时注入折叠标记和 CSS 变量。
+ * 折叠行为可通过插件选项全局控制，或通过代码围栏信息字符串中的
+ * `:collapsed-lines` 指令对单个代码块进行控制。
  *
+ * @param md - MarkdownIt instance / MarkdownIt 实例
+ * @param options - Plugin options, can be:
+ *   - `false`: Do not enable globally (default) / 不全局启用（默认）
+ *   - `true`: Enable with default 15 lines / 启用，默认 15 行起折叠
+ *   - `number`: Enable with custom starting line count / 启用，自定义起始折叠行数
+ *   - `'disable'`: Completely disable the plugin / 完全禁用插件
  * @example
  * ```ts
  * import { collapsedLinesMarkdownPlugin } from 'vitepress-code-collapse'

package/dist/node/index.js

@@ -51,13 +51,25 @@ function resolveCollapsedLines(info) {
 //#endregion
 //#region src/node/markdown.ts
 /**
-* Add collapsed lines functionality to code blocks in markdown-it
+* Adds collapsed lines functionality to code blocks in markdown-it.
 *
-* 为 markdown-it 中的代码块添加折叠行功能
+* Wraps the default fence renderer to inject collapse markers and CSS variables
+* when code blocks exceed a specified line count. The collapse behavior can be
+* controlled globally via plugin options or per code block via `:collapsed-lines`
+* directives in the code fence info string.
 *
-* @param md - MarkdownIt instance / MarkdownIt 实例
-* @param options - Plugin options / 插件选项
+* 为 markdown-it 中的代码块添加折叠行功能。
+*
+* 包装默认的 fence 渲染器，当代码块超过指定行数时注入折叠标记和 CSS 变量。
+* 折叠行为可通过插件选项全局控制，或通过代码围栏信息字符串中的
+* `:collapsed-lines` 指令对单个代码块进行控制。
 *
+* @param md - MarkdownIt instance / MarkdownIt 实例
+* @param options - Plugin options, can be:
+*   - `false`: Do not enable globally (default) / 不全局启用（默认）
+*   - `true`: Enable with default 15 lines / 启用，默认 15 行起折叠
+*   - `number`: Enable with custom starting line count / 启用，自定义起始折叠行数
+*   - `'disable'`: Completely disable the plugin / 完全禁用插件
 * @example
 * ```ts
 * import { collapsedLinesMarkdownPlugin } from 'vitepress-code-collapse'
@@ -95,6 +107,19 @@ const collapsedLinesMarkdownPlugin = (md, options = false) => {
 //#endregion
 //#region src/node/plugin.ts
 /**
+* VitePress plugin for collapsing code blocks that exceed a specified line count.
+*
+* Integrates markdown-it rendering (to inject collapse markers and CSS variables)
+* with client-side setup (to handle click interactions for expanding/collapsing).
+* Code blocks can be configured globally via plugin options or individually via
+* `:collapsed-lines` directives in the code fence info string.
+*
+* VitePress 插件，用于折叠超过指定行数的代码块。
+*
+* 将 markdown-it 渲染（注入折叠标记和 CSS 变量）与客户端设置（处理展开/折叠的
+* 点击交互）集成在一起。代码块可通过插件选项全局配置，或通过代码围栏信息字符串
+* 中的 `:collapsed-lines` 指令单独配置。
+*
 * @example
 * ```ts
 * import collapsedLines from 'vitepress-code-collapse'

package/package.json

@@ -1,15 +1,19 @@
 {
   "name": "vitepress-plugin-code-collapse",
   "type": "module",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "provide code block collapsed lines feature",
   "author": "pengzhanbo <q942450674@outlook.com> (https://github.com/pengzhanbo/)",
   "license": "MIT",
+  "homepage": "https://tuck.pengzhanbo.cn/plugins/code-collapse",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/pengzhanbo/vitepress-tuck.git",
     "directory": "packages/plugin-code-collapse"
   },
+  "bugs": {
+    "url": "https://github.com/pengzhanbo/vitepress-tuck/issues"
+  },
   "keywords": [
     "vitepress",
     "vitepress-plugin",
@@ -35,8 +39,8 @@
   },
   "dependencies": {
     "@vueuse/core": "^14.3.0",
-    "vitepress-plugin-toolkit": "0.3.0",
-    "vitepress-tuck": "0.3.0"
+    "vitepress-plugin-toolkit": "0.4.0",
+    "vitepress-tuck": "0.4.0"
   },
   "publishConfig": {
     "access": "public",