@mdit-vue/plugin-frontmatter 0.12.0 → 1.0.0

package/dist/index.cjs

@@ -2,10 +2,14 @@
 
 const grayMatter = require('gray-matter');
 
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
+
+const grayMatter__default = /*#__PURE__*/_interopDefaultCompat(grayMatter);
+
 const frontmatterPlugin = (md, { grayMatterOptions, renderExcerpt = true } = {}) => {
   const render = md.render.bind(md);
   md.render = (src, env = {}) => {
-    const { data, content, excerpt = "" } = grayMatter(src, grayMatterOptions);
+    const { data, content, excerpt = "" } = grayMatter__default(src, grayMatterOptions);
     env.content = content;
     env.frontmatter = {
       // allow providing default value

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

@@ -46,4 +46,4 @@ declare module '@mdit-vue/types' {
  */
 declare const frontmatterPlugin: MarkdownIt.PluginWithOptions<FrontmatterPluginOptions>;
 
-export { FrontmatterPluginOptions, frontmatterPlugin };
+export { type FrontmatterPluginOptions, frontmatterPlugin };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mdit-vue/plugin-frontmatter",
-  "version": "0.12.0",
+  "version": "1.0.0",
   "description": "A markdown-it plugin to get markdown frontmatter",
   "keywords": [
     "markdown-it",
@@ -22,9 +22,14 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs"
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
     }
   },
   "main": "./dist/index.cjs",
@@ -38,13 +43,13 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@mdit-vue/types": "0.12.0",
-    "@types/markdown-it": "^12.2.3",
+    "@mdit-vue/types": "1.0.0",
+    "@types/markdown-it": "^13.0.1",
     "gray-matter": "^4.0.3",
     "markdown-it": "^13.0.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "986b6023d3460cadefd409cd5d4b6445af3a05bd"
+  "gitHead": "d5388b9a8ec1e9075c41587410151ec2a6bc0df1"
 }