vuepress-plugin-md-power 1.0.0-rc.96 → 1.0.0-rc.98

package/lib/shared/index.d.ts

@@ -25,61 +25,6 @@ interface SizeOptions {
     ratio?: number | string;
 }
 
-type PDFEmbedType = 'iframe' | 'embed' | 'pdfjs';
-interface PDFTokenMeta extends SizeOptions {
-    page?: number;
-    noToolbar?: boolean;
-    zoom?: number;
-    src?: string;
-    title?: string;
-}
-interface PDFOptions {
-    /**
-     * pdfjs url
-     */
-    pdfjsUrl?: string;
-}
-
-interface IconsOptions {
-    /**
-     * The prefix of the icon className
-     * @default 'vp-mdi'
-     */
-    prefix?: string;
-    /**
-     * The size of the icon
-     * @default '1em'
-     */
-    size?: string | number;
-    /**
-     * The color of the icon
-     * @default 'currentColor'
-     */
-    color?: string;
-}
-
-interface VideoOptions {
-    bilibili?: boolean;
-    youtube?: boolean;
-}
-interface BilibiliTokenMeta extends SizeOptions {
-    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;
-}
-
 interface CodepenTokenMeta extends SizeOptions {
     title?: string;
     user?: string;
@@ -101,32 +46,22 @@ interface CodeSandboxTokenMeta extends SizeOptions {
     console?: boolean;
 }
 
-type ThemeOptions = BuiltinTheme | {
-    light: BuiltinTheme;
-    dark: BuiltinTheme;
-};
-interface ReplOptions {
-    theme?: ThemeOptions;
-    go?: boolean;
-    kotlin?: boolean;
-    rust?: boolean;
-}
-interface ReplEditorData {
-    grammars: {
-        go?: any;
-        kotlin?: any;
-        rust?: any;
-    };
-    theme: ThemeRegistration | {
-        light: ThemeRegistration;
-        dark: ThemeRegistration;
-    };
-}
-
-interface ReplitTokenMeta extends SizeOptions {
-    title?: string;
-    source?: string;
-    theme?: string;
+interface IconsOptions {
+    /**
+     * The prefix of the icon className
+     * @default 'vp-mdi'
+     */
+    prefix?: string;
+    /**
+     * The size of the icon
+     * @default '1em'
+     */
+    size?: string | number;
+    /**
+     * The color of the icon
+     * @default 'currentColor'
+     */
+    color?: string;
 }
 
 interface JSFiddleTokenMeta extends SizeOptions {
@@ -137,6 +72,21 @@ interface JSFiddleTokenMeta extends SizeOptions {
     tab?: string;
 }
 
+type PDFEmbedType = 'iframe' | 'embed' | 'pdfjs';
+interface PDFTokenMeta extends SizeOptions {
+    page?: number;
+    noToolbar?: boolean;
+    zoom?: number;
+    src?: string;
+    title?: string;
+}
+interface PDFOptions {
+    /**
+     * pdfjs url
+     */
+    pdfjsUrl?: string;
+}
+
 interface PlotOptions {
     /**
      * 是否启用 `=| |=`  markdown （该标记为非标准标记，脱离插件将不生效）
@@ -165,22 +115,163 @@ interface PlotOptions {
     trigger?: 'hover' | 'click';
 }
 
+type ThemeOptions = BuiltinTheme | {
+    light: BuiltinTheme;
+    dark: BuiltinTheme;
+};
+interface ReplOptions {
+    theme?: ThemeOptions;
+    go?: boolean;
+    kotlin?: boolean;
+    rust?: boolean;
+}
+interface ReplEditorData {
+    grammars: {
+        go?: any;
+        kotlin?: any;
+        rust?: any;
+    };
+    theme: ThemeRegistration | {
+        light: ThemeRegistration;
+        dark: ThemeRegistration;
+    };
+}
+
 interface MarkdownPowerPluginOptions {
+    /**
+     * 是否启用 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;
+    /**
+     * 是否启用 bilibili 视频嵌入
+     *
+     * `@[bilibili](bid)`
+     *
+     * @default false
+     */
     bilibili?: boolean;
+    /**
+     * 是否启用 youtube 视频嵌入
+     *
+     * `@[youtube](video_id)`
+     *
+     * @default false
+     */
     youtube?: 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;
+    /**
+     * 是否启用 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';
+}
+
+interface ReplitTokenMeta extends SizeOptions {
+    title?: string;
+    source?: string;
+    theme?: string;
+}
+
+interface VideoOptions {
+    bilibili?: boolean;
+    youtube?: boolean;
+}
+interface BilibiliTokenMeta extends SizeOptions {
+    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;
 }
 
 export type { BilibiliTokenMeta, CanIUseMode, CanIUseOptions, CanIUseTokenMeta, CodeSandboxTokenMeta, CodepenTokenMeta, IconsOptions, JSFiddleTokenMeta, MarkdownPowerPluginOptions, PDFEmbedType, PDFOptions, PDFTokenMeta, PlotOptions, ReplEditorData, ReplOptions, ReplitTokenMeta, SizeOptions, ThemeOptions, VideoOptions, YoutubeTokenMeta };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vuepress-plugin-md-power",
   "type": "module",
-  "version": "1.0.0-rc.96",
+  "version": "1.0.0-rc.98",
   "description": "The Plugin for VuePress 2 - markdown power",
   "author": "pengzhanbo <volodymyr@foxmail.com>",
   "license": "MIT",
@@ -36,12 +36,13 @@
   "dependencies": {
     "@vuepress/helper": "2.0.0-rc.42",
     "@vueuse/core": "^11.0.3",
+    "image-size": "^1.1.1",
     "markdown-it-container": "^4.0.0",
     "nanoid": "^5.0.7",
-    "shiki": "^1.16.2",
-    "tm-grammars": "^1.17.16",
+    "shiki": "^1.17.0",
+    "tm-grammars": "^1.17.18",
     "tm-themes": "^1.8.1",
-    "vue": "^3.5.2"
+    "vue": "^3.5.4"
   },
   "devDependencies": {
     "@types/markdown-it": "^14.1.2"