vuepress-plugin-md-power 1.0.0-rc.145 → 1.0.0-rc.147

package/lib/shared/index.d.ts

@@ -1,414 +1,463 @@
-import Token from 'markdown-it/lib/token.mjs';
-import { App } from 'vuepress';
-import { MarkdownEnv, Markdown } from 'vuepress/markdown';
-import { BuiltinTheme, ThemeRegistration } from 'shiki';
+import Token from "markdown-it/lib/token.mjs";
+import { App } from "vuepress";
+import { Markdown, MarkdownEnv } from "vuepress/markdown";
+import { BuiltinTheme, ThemeRegistration } from "shiki";
 
-type CanIUseMode = 'embed' | 'image';
+//#region src/shared/caniuse.d.ts
+type CanIUseMode = "embed" | "image";
 interface CanIUseTokenMeta {
-    feature: string;
-    mode: CanIUseMode;
-    versions: string;
+  feature: string;
+  mode: CanIUseMode;
+  versions: string;
 }
 interface CanIUseOptions {
-    /**
-     * 嵌入模式
-     *
-     * embed 通过iframe嵌入，提供可交互视图
-     *
-     * image 通过图片嵌入，静态
-     *
-     * @default 'embed'
-     */
-    mode?: CanIUseMode;
-}
-
+  /**
+  * 嵌入模式
+  *
+  * embed 通过iframe嵌入，提供可交互视图
+  *
+  * image 通过图片嵌入，静态
+  *
+  * @default 'embed'
+  */
+  mode?: CanIUseMode;
+} //#endregion
+//#region src/shared/size.d.ts
 interface SizeOptions {
-    width?: string;
-    height?: string;
-    ratio?: number | string;
+  width?: string;
+  height?: string;
+  ratio?: number | string;
 }
 
+//#endregion
+//#region src/shared/codepen.d.ts
 interface CodepenTokenMeta extends SizeOptions {
-    title?: string;
-    user?: string;
-    slash?: string;
-    tab?: string;
-    theme?: string;
-    preview?: boolean;
-    editable?: boolean;
+  title?: string;
+  user?: string;
+  slash?: string;
+  tab?: string;
+  theme?: string;
+  preview?: boolean;
+  editable?: boolean;
 }
 
+//#endregion
+//#region src/shared/codeSandbox.d.ts
 interface CodeSandboxTokenMeta extends SizeOptions {
-    user?: string;
-    id?: string;
-    layout?: string;
-    type?: 'button' | 'embed';
-    title?: string;
-    filepath?: string;
-    navbar?: boolean;
-    console?: boolean;
+  user?: string;
+  id?: string;
+  layout?: string;
+  type?: "button" | "embed";
+  title?: string;
+  filepath?: string;
+  navbar?: boolean;
+  console?: boolean;
 }
 
+//#endregion
+//#region src/shared/codeTabs.d.ts
 interface CodeTabsOptions {
-    icon?: boolean | {
-        named?: false | string[];
-        extensions?: false | string[];
-    };
+  icon?: boolean | {
+    named?: false | string[];
+    extensions?: false | string[];
+  };
 }
 
+//#endregion
+//#region src/shared/demo.d.ts
 interface DemoFile {
-    type: 'vue' | 'normal' | 'css' | 'markdown';
-    export?: string;
-    path: string;
-    gitignore?: boolean;
+  type: "vue" | "normal" | "css" | "markdown";
+  export?: string;
+  path: string;
+  gitignore?: boolean;
 }
 interface MarkdownDemoEnv extends MarkdownEnv {
-    demoFiles?: DemoFile[];
+  demoFiles?: DemoFile[];
 }
 interface DemoMeta {
-    type: 'vue' | 'normal' | 'markdown';
-    url: string;
-    title?: string;
-    desc?: string;
-    codeSetting?: string;
-    expanded?: boolean;
+  type: "vue" | "normal" | "markdown";
+  url: string;
+  title?: string;
+  desc?: string;
+  codeSetting?: string;
+  expanded?: boolean;
 }
 interface DemoContainerRender {
-    before: (app: App, md: Markdown, env: MarkdownDemoEnv, meta: DemoMeta, codeMap: Record<string, string>) => string;
-    after: () => string;
-    token?: (token: Token, tokens: Token[], index: number) => void;
+  before: (app: App, md: Markdown, env: MarkdownDemoEnv, meta: DemoMeta, codeMap: Record<string, string>) => string;
+  after: () => string;
+  token?: (token: Token, tokens: Token[], index: number) => void;
 }
 
-type FileTreeIconMode = 'simple' | 'colored';
+//#endregion
+//#region src/shared/fileTree.d.ts
+type FileTreeIconMode = "simple" | "colored";
 interface FileTreeOptions {
-    icon?: FileTreeIconMode;
+  icon?: FileTreeIconMode;
 }
 
+//#endregion
+//#region src/shared/icons.d.ts
 interface IconsOptions {
-    /**
-     * The size of the icon
-     * @default '1em'
-     */
-    size?: string | number;
-    /**
-     * The color of the icon
-     * @default 'currentColor'
-     */
-    color?: string;
+  /**
+  * The size of the icon
+  * @default '1em'
+  */
+  size?: string | number;
+  /**
+  * The color of the icon
+  * @default 'currentColor'
+  */
+  color?: string;
 }
 
+//#endregion
+//#region src/shared/jsfiddle.d.ts
 interface JSFiddleTokenMeta extends SizeOptions {
-    source: string;
-    title?: string;
-    theme?: string;
-    tab?: string;
+  source: string;
+  title?: string;
+  theme?: string;
+  tab?: string;
 }
 
-type NpmToPackageManager = 'npm' | 'pnpm' | 'yarn' | 'bun' | 'deno';
+//#endregion
+//#region src/shared/npmTo.d.ts
+type NpmToPackageManager = "npm" | "pnpm" | "yarn" | "bun" | "deno";
 type NpmToOptions = NpmToPackageManager[] | {
-    tabs?: NpmToPackageManager[];
+  tabs?: NpmToPackageManager[];
 };
 
-type PDFEmbedType = 'iframe' | 'embed' | 'pdfjs';
+//#endregion
+//#region src/shared/pdf.d.ts
+type PDFEmbedType = "iframe" | "embed" | "pdfjs";
 interface PDFTokenMeta extends SizeOptions {
-    page?: number;
-    noToolbar?: boolean;
-    zoom?: number;
-    src?: string;
-    title?: string;
+  page?: number;
+  noToolbar?: boolean;
+  zoom?: number;
+  src?: string;
+  title?: string;
 }
 interface PDFOptions {
-    /**
-     * pdfjs url
-     */
-    pdfjsUrl?: string;
+  /**
+  * pdfjs url
+  */
+  pdfjsUrl?: string;
 }
 
+//#endregion
+//#region src/shared/plot.d.ts
 interface PlotOptions {
-    /**
-     * 是否启用 `!! !!`  markdown （该标记为非标准标记，脱离插件将不生效）
-     * @default true
-     */
-    tag?: boolean;
-    /**
-     * 遮罩层颜色
-     */
-    mask?: string | {
-        light: string;
-        dark: string;
-    };
-    /**
-     * 文本颜色
-     */
-    color?: string | {
-        light: string;
-        dark: string;
-    };
-    /**
-     * 触发方式
-     *
-     * @default 'hover'
-     */
-    trigger?: 'hover' | 'click';
+  /**
+  * 是否启用 `!! !!`  markdown （该标记为非标准标记，脱离插件将不生效）
+  * @default true
+  */
+  tag?: boolean;
+  /**
+  * 遮罩层颜色
+  */
+  mask?: string | {
+    light: string;
+    dark: string;
+  };
+  /**
+  * 文本颜色
+  */
+  color?: string | {
+    light: string;
+    dark: string;
+  };
+  /**
+  * 触发方式
+  *
+  * @default 'hover'
+  */
+  trigger?: "hover" | "click";
+}
+
+//#endregion
+//#region src/shared/codeTree.d.ts
+interface CodeTreeOptions {
+  icon?: FileTreeIconMode;
+  height?: string | number;
 }
 
+//#endregion
+//#region src/shared/repl.d.ts
 type ThemeOptions = BuiltinTheme | {
-    light: BuiltinTheme;
-    dark: BuiltinTheme;
+  light: BuiltinTheme;
+  dark: BuiltinTheme;
 };
 interface ReplOptions {
-    theme?: ThemeOptions;
-    go?: boolean;
-    kotlin?: boolean;
-    rust?: boolean;
+  theme?: ThemeOptions;
+  go?: boolean;
+  kotlin?: boolean;
+  rust?: boolean;
 }
 interface ReplEditorData {
-    grammars: {
-        go?: any;
-        kotlin?: any;
-        rust?: any;
-    };
-    theme: ThemeRegistration | {
-        light: ThemeRegistration;
-        dark: ThemeRegistration;
-    };
+  grammars: {
+    go?: any;
+    kotlin?: any;
+    rust?: any;
+  };
+  theme: ThemeRegistration | {
+    light: ThemeRegistration;
+    dark: ThemeRegistration;
+  };
 }
 
+//#endregion
+//#region src/shared/plugin.d.ts
 interface MarkdownPowerPluginOptions {
-    /**
-     * 是否启用注释
-     * @default false
-     */
-    annotation?: boolean;
-    /**
-     * 是否启用 abbr 语法
-     * @default false
-     */
-    abbr?: boolean;
-    /**
-     * 配置代码块分组
-     */
-    codeTabs?: CodeTabsOptions;
-    /**
-     * 是否启用 npm-to 容器
-     */
-    npmTo?: boolean | NpmToOptions;
-    /**
-     * 是否启用 PDF 嵌入语法
-     *
-     * `@[pdf](pdf_url)`
-     *
-     * @default false
-     */
-    pdf?: boolean | PDFOptions;
-    /**
-     * 是否启用 iconify 图标嵌入语法
-     *
-     * `::collect:icon_name::`
-     *
-     * @default false
-     */
-    icons?: boolean | IconsOptions;
-    /**
-     * 是否启用 隐秘文本 语法
-     *
-     * `!!plot_content!!`
-     *
-     * @default false
-     */
-    plot?: boolean | PlotOptions;
-    /**
-     * 是否启用 timeline 语法
-     *
-     * ```md
-     * ::: timeline
-     * - title
-     *   time="Q1" icon="ri:clockwise-line" line="dashed" type="warning" color="red"
-     *
-     *   xxx
-     * :::
-     * ```
-     *
-     * @default false
-     */
-    timeline?: boolean;
-    /**
-     * 是否启用 collapse 折叠面板 语法
-     *
-     * ```md
-     * ::: collapse accordion
-     * - + title
-     *
-     *   content
-     *
-     * - - title
-     *
-     *   content
-     * :::
-     * ```
-     *
-     * @default false
-     */
-    collapse?: boolean;
-    /**
-     * 是否启用 chat 容器 语法
-     *
-     * ```md
-     * ::: chat
-     * {:date}
-     *
-     * {user}
-     * message
-     *
-     * {.}
-     * message
-     * :::
-     * ```
-     * @default false
-     */
-    chat?: boolean;
-    /**
-     * 是否启用 field / field-group 容器
-     *
-     * @default false
-     */
-    field?: boolean;
-    /**
-     * 是否启用 bilibili 视频嵌入
-     *
-     * `@[bilibili](bid)`
-     *
-     * @default false
-     */
-    bilibili?: boolean;
-    /**
-     * 是否启用 youtube 视频嵌入
-     *
-     * `@[youtube](video_id)`
-     *
-     * @default false
-     */
-    youtube?: boolean;
-    /**
-     * 是否启用 artPlayer 视频嵌入
-     *
-     * `@[artPlayer](url)`
-     */
-    artPlayer?: boolean;
-    /**
-     * 是否启用 audioReader 音频嵌入
-     *
-     * `@[audioReader](url)`
-     */
-    audioReader?: boolean;
-    /**
-     * 是否启用 codepen 嵌入
-     *
-     * `@[codepen](pen_id)`
-     *
-     * @default false
-     */
-    codepen?: boolean;
-    /**
-     * @deprecated
-     */
-    replit?: boolean;
-    /**
-     * 是否启用 codeSandbox 嵌入
-     *
-     * `@[codesandbox](codesandbox_id)`
-     *
-     * @default false
-     */
-    codeSandbox?: boolean;
-    /**
-     * 是否启用 jsfiddle 嵌入
-     *
-     * `@[jsfiddle](jsfiddle_id)`
-     *
-     * @default false
-     */
-    jsfiddle?: boolean;
-    /**
-     * 是否启用 REPL 容器语法
-     *
-     * @default false
-     */
-    repl?: false | ReplOptions;
-    /**
-     * 是否启用 文件树 容器语法
-     *
-     * @default false
-     */
-    fileTree?: boolean | FileTreeOptions;
-    /**
-     * 是否启用 demo 语法
-     */
-    demo?: boolean;
-    /**
-     * 是否启用 caniuse 嵌入语法
-     *
-     * `@[caniuse](feature_name)`
-     *
-     * @default false
-     */
-    caniuse?: boolean | CanIUseOptions;
-    /**
-     * 是否启用 自动填充 图片宽高属性
-     *
-     * __请注意，无论是否启用，该功能仅在构建生产包时生效__
-     *
-     * - 如果为 `true` ，等同于 `'local'`
-     * - 如果为 `local`，则仅对本地图片 添加 width 和 height
-     * - 如果为 `all`，则对所有图片(即包括 本地 和 远程) 添加 width 和 height
-     *
-     * 图片在加载过程中如果比较慢，从加载到完成的过程会导致页面布局不稳定，导致内容闪烁等。
-     * 此功能通过给图片添加 `width` 和 `height` 属性来解决该问题。
-     *
-     * 请谨慎使用 `all` 选项，该选项会在构建阶段发起网络请求，尝试加载远程图片以获取图片尺寸信息，
-     * 这可能会导致 构建时间变得更长（幸运的是获取尺寸信息只需要加载图片 几 KB 的数据包，因此耗时不会过长）
-     *
-     * @default false
-     */
-    imageSize?: boolean | 'local' | 'all';
-}
-
+  /**
+  * 是否启用注释
+  * @default false
+  */
+  annotation?: boolean;
+  /**
+  * 是否启用 abbr 语法
+  * @default false
+  */
+  abbr?: boolean;
+  /**
+  * 配置代码块分组
+  */
+  codeTabs?: CodeTabsOptions;
+  /**
+  * 是否启用 npm-to 容器
+  */
+  npmTo?: boolean | NpmToOptions;
+  /**
+  * 是否启用 PDF 嵌入语法
+  *
+  * `@[pdf](pdf_url)`
+  *
+  * @default false
+  */
+  pdf?: boolean | PDFOptions;
+  /**
+  * 是否启用 iconify 图标嵌入语法
+  *
+  * `::collect:icon_name::`
+  *
+  * @default false
+  */
+  icons?: boolean | IconsOptions;
+  /**
+  * 是否启用 隐秘文本 语法
+  *
+  * `!!plot_content!!`
+  *
+  * @default false
+  */
+  plot?: boolean | PlotOptions;
+  /**
+  * 是否启用 timeline 语法
+  *
+  * ```md
+  * ::: timeline
+  * - title
+  *   time="Q1" icon="ri:clockwise-line" line="dashed" type="warning" color="red"
+  *
+  *   xxx
+  * :::
+  * ```
+  *
+  * @default false
+  */
+  timeline?: boolean;
+  /**
+  * 是否启用 collapse 折叠面板 语法
+  *
+  * ```md
+  * ::: collapse accordion
+  * - + title
+  *
+  *   content
+  *
+  * - - title
+  *
+  *   content
+  * :::
+  * ```
+  *
+  * @default false
+  */
+  collapse?: boolean;
+  /**
+  * 是否启用 chat 容器 语法
+  *
+  * ```md
+  * ::: chat
+  * {:date}
+  *
+  * {user}
+  * message
+  *
+  * {.}
+  * message
+  * :::
+  * ```
+  * @default false
+  */
+  chat?: boolean;
+  /**
+  * 是否启用 field / field-group 容器
+  *
+  * @default false
+  */
+  field?: boolean;
+  /**
+  * 是否启用 bilibili 视频嵌入
+  *
+  * `@[bilibili](bid)`
+  *
+  * @default false
+  */
+  bilibili?: boolean;
+  /**
+  * 是否启用 youtube 视频嵌入
+  *
+  * `@[youtube](video_id)`
+  *
+  * @default false
+  */
+  youtube?: boolean;
+  /**
+  * 是否启用 artPlayer 视频嵌入
+  *
+  * `@[artPlayer](url)`
+  */
+  artPlayer?: boolean;
+  /**
+  * 是否启用 audioReader 音频嵌入
+  *
+  * `@[audioReader](url)`
+  */
+  audioReader?: boolean;
+  /**
+  * 是否启用 codepen 嵌入
+  *
+  * `@[codepen](pen_id)`
+  *
+  * @default false
+  */
+  codepen?: boolean;
+  /**
+  * @deprecated
+  */
+  replit?: boolean;
+  /**
+  * 是否启用 codeSandbox 嵌入
+  *
+  * `@[codesandbox](codesandbox_id)`
+  *
+  * @default false
+  */
+  codeSandbox?: boolean;
+  /**
+  * 是否启用 jsfiddle 嵌入
+  *
+  * `@[jsfiddle](jsfiddle_id)`
+  *
+  * @default false
+  */
+  jsfiddle?: boolean;
+  /**
+  * 是否启用 REPL 容器语法
+  *
+  * @default false
+  */
+  repl?: false | ReplOptions;
+  /**
+  * 是否启用 文件树 容器语法
+  *
+  * @default false
+  */
+  fileTree?: boolean | FileTreeOptions;
+  /**
+  * 是否启用 代码树 容器语法 和 嵌入语法
+  *
+  * ```md
+  * ::: code-tree
+  * :::
+  * ```
+  *
+  * `@[code-tree](file_path)`
+  *
+  *
+  * @default false
+  */
+  codeTree?: boolean | CodeTreeOptions;
+  /**
+  * 是否启用 demo 语法
+  */
+  demo?: boolean;
+  /**
+  * 是否启用 caniuse 嵌入语法
+  *
+  * `@[caniuse](feature_name)`
+  *
+  * @default false
+  */
+  caniuse?: boolean | CanIUseOptions;
+  /**
+  * 是否启用 自动填充 图片宽高属性
+  *
+  * __请注意，无论是否启用，该功能仅在构建生产包时生效__
+  *
+  * - 如果为 `true` ，等同于 `'local'`
+  * - 如果为 `local`，则仅对本地图片 添加 width 和 height
+  * - 如果为 `all`，则对所有图片(即包括 本地 和 远程) 添加 width 和 height
+  *
+  * 图片在加载过程中如果比较慢，从加载到完成的过程会导致页面布局不稳定，导致内容闪烁等。
+  * 此功能通过给图片添加 `width` 和 `height` 属性来解决该问题。
+  *
+  * 请谨慎使用 `all` 选项，该选项会在构建阶段发起网络请求，尝试加载远程图片以获取图片尺寸信息，
+  * 这可能会导致 构建时间变得更长（幸运的是获取尺寸信息只需要加载图片 几 KB 的数据包，因此耗时不会过长）
+  *
+  * @default false
+  */
+  imageSize?: boolean | "local" | "all";
+} //#endregion
+//#region src/shared/replit.d.ts
 interface ReplitTokenMeta extends SizeOptions {
-    title?: string;
-    source?: string;
-    theme?: string;
+  title?: string;
+  source?: string;
+  theme?: string;
 }
 
+//#endregion
+//#region src/shared/video.d.ts
 interface VideoOptions {
-    bilibili?: boolean;
-    youtube?: boolean;
+  bilibili?: boolean;
+  youtube?: boolean;
 }
 interface BilibiliTokenMeta extends SizeOptions {
-    title?: string;
-    bvid?: string;
-    aid?: string;
-    cid?: string;
-    autoplay?: boolean;
-    time?: string | number;
-    page?: number;
+  title?: string;
+  bvid?: string;
+  aid?: string;
+  cid?: string;
+  autoplay?: boolean;
+  time?: string | number;
+  page?: number;
 }
 interface YoutubeTokenMeta extends SizeOptions {
-    title?: string;
-    id: string;
-    autoplay?: boolean;
-    loop?: boolean;
-    start?: string | number;
-    end?: string | number;
+  title?: string;
+  id: string;
+  autoplay?: boolean;
+  loop?: boolean;
+  start?: string | number;
+  end?: string | number;
 }
 interface ArtPlayerTokenMeta extends SizeOptions {
-    muted?: boolean;
-    autoplay?: boolean;
-    autoMini?: boolean;
-    loop?: boolean;
-    volume?: number;
-    poster?: string;
-    url: string;
-    type?: string;
+  muted?: boolean;
+  autoplay?: boolean;
+  autoMini?: boolean;
+  loop?: boolean;
+  volume?: number;
+  poster?: string;
+  url: string;
+  type?: string;
 }
 
-export type { ArtPlayerTokenMeta, BilibiliTokenMeta, CanIUseMode, CanIUseOptions, CanIUseTokenMeta, CodeSandboxTokenMeta, CodeTabsOptions, CodepenTokenMeta, DemoContainerRender, DemoFile, DemoMeta, FileTreeIconMode, FileTreeOptions, IconsOptions, JSFiddleTokenMeta, MarkdownDemoEnv, MarkdownPowerPluginOptions, NpmToOptions, NpmToPackageManager, PDFEmbedType, PDFOptions, PDFTokenMeta, PlotOptions, ReplEditorData, ReplOptions, ReplitTokenMeta, SizeOptions, ThemeOptions, VideoOptions, YoutubeTokenMeta };
+//#endregion
+export { ArtPlayerTokenMeta, BilibiliTokenMeta, CanIUseMode, CanIUseOptions, CanIUseTokenMeta, CodeSandboxTokenMeta, CodeTabsOptions, CodepenTokenMeta, DemoContainerRender, DemoFile, DemoMeta, FileTreeIconMode, FileTreeOptions, IconsOptions, JSFiddleTokenMeta, MarkdownDemoEnv, MarkdownPowerPluginOptions, NpmToOptions, NpmToPackageManager, PDFEmbedType, PDFOptions, PDFTokenMeta, PlotOptions, ReplEditorData, ReplOptions, ReplitTokenMeta, SizeOptions, ThemeOptions, VideoOptions, YoutubeTokenMeta };