@mdit-vue/plugin-frontmatter 0.11.1 → 0.12.1

package/dist/index.cjs

@@ -1,12 +1,10 @@
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 const grayMatter = require('gray-matter');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e["default"] : e; }
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
 
-const grayMatter__default = /*#__PURE__*/_interopDefaultLegacy(grayMatter);
+const grayMatter__default = /*#__PURE__*/_interopDefaultCompat(grayMatter);
 
 const frontmatterPlugin = (md, { grayMatterOptions, renderExcerpt = true } = {}) => {
   const render = md.render.bind(md);
@@ -14,10 +12,19 @@ const frontmatterPlugin = (md, { grayMatterOptions, renderExcerpt = true } = {})
     const { data, content, excerpt = "" } = grayMatter__default(src, grayMatterOptions);
     env.content = content;
     env.frontmatter = {
+      // allow providing default value
       ...env.frontmatter,
       ...data
     };
-    env.excerpt = renderExcerpt && excerpt ? render(excerpt, { ...env }) : excerpt;
+    env.excerpt = renderExcerpt && excerpt ? (
+      // render the excerpt with original markdown-it render method.
+      // here we spread `env` to avoid mutating the original object.
+      // using deep clone might be a safer choice.
+      render(excerpt, { ...env })
+    ) : (
+      // use the raw excerpt directly
+      excerpt
+    );
     return render(content, env);
   };
 };

package/dist/index.d.cts

@@ -0,0 +1,49 @@
+import MarkdownIt from 'markdown-it';
+import matter from 'gray-matter';
+
+type GrayMatterOptions = matter.GrayMatterOption<string, GrayMatterOptions>;
+/**
+ * Options of @mdit-vue/plugin-frontmatter
+ */
+interface FrontmatterPluginOptions {
+    /**
+     * Options of gray-matter
+     *
+     * @see https://github.com/jonschlinkert/gray-matter#options
+     */
+    grayMatterOptions?: GrayMatterOptions;
+    /**
+     * Render the excerpt or not
+     *
+     * @default true
+     */
+    renderExcerpt?: boolean;
+}
+declare module '@mdit-vue/types' {
+    interface MarkdownItEnv {
+        /**
+         * The raw Markdown content without frontmatter
+         */
+        content?: string;
+        /**
+         * The excerpt that extracted by `@mdit-vue/plugin-frontmatter`
+         *
+         * - Would be the rendered HTML when `renderExcerpt` is enabled
+         * - Would be the raw Markdown when `renderExcerpt` is disabled
+         */
+        excerpt?: string;
+        /**
+         * The frontmatter that extracted by `@mdit-vue/plugin-frontmatter`
+         */
+        frontmatter?: Record<string, unknown>;
+    }
+}
+
+/**
+ * Get markdown frontmatter and excerpt
+ *
+ * Extract them into env
+ */
+declare const frontmatterPlugin: MarkdownIt.PluginWithOptions<FrontmatterPluginOptions>;
+
+export { type FrontmatterPluginOptions, frontmatterPlugin };

package/dist/index.d.mts

@@ -0,0 +1,49 @@
+import MarkdownIt from 'markdown-it';
+import matter from 'gray-matter';
+
+type GrayMatterOptions = matter.GrayMatterOption<string, GrayMatterOptions>;
+/**
+ * Options of @mdit-vue/plugin-frontmatter
+ */
+interface FrontmatterPluginOptions {
+    /**
+     * Options of gray-matter
+     *
+     * @see https://github.com/jonschlinkert/gray-matter#options
+     */
+    grayMatterOptions?: GrayMatterOptions;
+    /**
+     * Render the excerpt or not
+     *
+     * @default true
+     */
+    renderExcerpt?: boolean;
+}
+declare module '@mdit-vue/types' {
+    interface MarkdownItEnv {
+        /**
+         * The raw Markdown content without frontmatter
+         */
+        content?: string;
+        /**
+         * The excerpt that extracted by `@mdit-vue/plugin-frontmatter`
+         *
+         * - Would be the rendered HTML when `renderExcerpt` is enabled
+         * - Would be the raw Markdown when `renderExcerpt` is disabled
+         */
+        excerpt?: string;
+        /**
+         * The frontmatter that extracted by `@mdit-vue/plugin-frontmatter`
+         */
+        frontmatter?: Record<string, unknown>;
+    }
+}
+
+/**
+ * Get markdown frontmatter and excerpt
+ *
+ * Extract them into env
+ */
+declare const frontmatterPlugin: MarkdownIt.PluginWithOptions<FrontmatterPluginOptions>;
+
+export { type FrontmatterPluginOptions, frontmatterPlugin };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import MarkdownIt from 'markdown-it';
 import matter from 'gray-matter';
 
-declare type GrayMatterOptions = matter.GrayMatterOption<string, GrayMatterOptions>;
+type GrayMatterOptions = matter.GrayMatterOption<string, GrayMatterOptions>;
 /**
  * Options of @mdit-vue/plugin-frontmatter
  */
@@ -46,4 +46,4 @@ declare module '@mdit-vue/types' {
  */
 declare const frontmatterPlugin: MarkdownIt.PluginWithOptions<FrontmatterPluginOptions>;
 
-export { FrontmatterPluginOptions, frontmatterPlugin };
+export { type FrontmatterPluginOptions, frontmatterPlugin };

package/dist/index.mjs

@@ -6,10 +6,19 @@ const frontmatterPlugin = (md, { grayMatterOptions, renderExcerpt = true } = {})
     const { data, content, excerpt = "" } = grayMatter(src, grayMatterOptions);
     env.content = content;
     env.frontmatter = {
+      // allow providing default value
       ...env.frontmatter,
       ...data
     };
-    env.excerpt = renderExcerpt && excerpt ? render(excerpt, { ...env }) : excerpt;
+    env.excerpt = renderExcerpt && excerpt ? (
+      // render the excerpt with original markdown-it render method.
+      // here we spread `env` to avoid mutating the original object.
+      // using deep clone might be a safer choice.
+      render(excerpt, { ...env })
+    ) : (
+      // use the raw excerpt directly
+      excerpt
+    );
     return render(content, env);
   };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mdit-vue/plugin-frontmatter",
-  "version": "0.11.1",
+  "version": "0.12.1",
   "description": "A markdown-it plugin to get markdown frontmatter",
   "keywords": [
     "markdown-it",
@@ -38,13 +38,13 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@mdit-vue/types": "0.11.0",
-    "@types/markdown-it": "^12.2.3",
+    "@mdit-vue/types": "0.12.0",
+    "@types/markdown-it": "^13.0.0",
     "gray-matter": "^4.0.3",
     "markdown-it": "^13.0.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "98828479d07c7bc52d178a00cdb92c166eff09ee"
+  "gitHead": "198a71b2e4175a92843609a63d2a848bddb71740"
 }