@md-plugins/md-plugin-frontmatter 0.1.0-alpha.9 → 0.1.0-beta.1

package/README.md

@@ -15,12 +15,12 @@ A **Markdown-It** plugin that extracts and processes frontmatter from Markdown c
 Install the plugin via your preferred package manager:
 
 ```bash
-# With npm:
-npm install @md-plugins/md-plugin-frontmatter
-# Or with Yarn:
-yarn add @md-plugins/md-plugin-frontmatter
-# Or with pnpm:
+# with pnpm:
 pnpm add @md-plugins/md-plugin-frontmatter
+# with Yarn:
+yarn add @md-plugins/md-plugin-frontmatter
+# with npm:
+npm install @md-plugins/md-plugin-frontmatter
 ```
 
 ## Usage
@@ -103,6 +103,10 @@ Run the unit tests with `Vitest` to ensure the plugin behaves as expected:
 pnpm test
 ```
 
+## Documentation
+
+In case this README falls out of date, please refer to the [documentation](https://md-plugins.netlify.app/md-plugins/frontmatter/overview) for the latest information.
+
 ## License
 
 This project is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for details.

package/dist/index.d.mts

@@ -44,10 +44,10 @@ declare module '@md-plugins/shared' {
 }
 
 /**
- * Get markdown frontmatter and excerpt
- *
- * Extract them into env
+ * Get markdown frontmatter and excerpt.
+ * Extract them into env.
  */
 declare const frontmatterPlugin: PluginWithOptions<FrontmatterPluginOptions>;
 
-export { type FrontmatterPluginOptions, frontmatterPlugin };
+export { frontmatterPlugin };
+export type { FrontmatterPluginOptions };

package/dist/index.d.ts

@@ -44,10 +44,10 @@ declare module '@md-plugins/shared' {
 }
 
 /**
- * Get markdown frontmatter and excerpt
- *
- * Extract them into env
+ * Get markdown frontmatter and excerpt.
+ * Extract them into env.
  */
 declare const frontmatterPlugin: PluginWithOptions<FrontmatterPluginOptions>;
 
-export { type FrontmatterPluginOptions, frontmatterPlugin };
+export { frontmatterPlugin };
+export type { FrontmatterPluginOptions };

package/dist/index.mjs

@@ -1,6 +1,26 @@
 import grayMatter from 'gray-matter';
 
-const frontmatterPlugin = (md, { grayMatterOptions, renderExcerpt = false } = {}) => {
+function resolvePluginOptions(options, key, defaults) {
+  if (options && typeof options === "object" && key in options) {
+    return { ...defaults, ...options[key] };
+  }
+  return { ...defaults, ...options };
+}
+
+const DEFAULT_FRONTMATTER_PLUGIN_OPTIONS = {
+  grayMatterOptions: {},
+  renderExcerpt: false
+};
+const frontmatterPlugin = (md, options) => {
+  const resolvedOptions = resolvePluginOptions(
+    options,
+    "frontmatterPlugin",
+    DEFAULT_FRONTMATTER_PLUGIN_OPTIONS
+  );
+  const {
+    grayMatterOptions = DEFAULT_FRONTMATTER_PLUGIN_OPTIONS.grayMatterOptions,
+    renderExcerpt = DEFAULT_FRONTMATTER_PLUGIN_OPTIONS.renderExcerpt
+  } = resolvedOptions;
   const render = md.render.bind(md);
   md.render = (src, env = {}) => {
     let data, content, excerpt;
@@ -15,17 +35,10 @@ const frontmatterPlugin = (md, { grayMatterOptions, renderExcerpt = false } = {}
     }
     env.content = content;
     env.frontmatter = {
-      // allow providing default value
       ...env.frontmatter,
       ...data
     };
-    env.excerpt = renderExcerpt && data.excerpt ? (
-      // render the excerpt with original markdown-it render method.
-      render(data.excerpt, env)
-    ) : (
-      // use the raw excerpt directly
-      excerpt
-    );
+    env.excerpt = renderExcerpt && data.excerpt ? render(data.excerpt, env) : excerpt;
     return render(content, env);
   };
 };

package/package.json

@@ -1,24 +1,29 @@
 {
   "name": "@md-plugins/md-plugin-frontmatter",
-  "version": "0.1.0-alpha.9",
+  "version": "0.1.0-beta.1",
   "description": "A markdown-it plugin for handling frontmatter in markdown files.",
   "keywords": [
     "markdown-it",
     "quasarframework",
-    "vue",
-    "types"
+    "types",
+    "vue"
   ],
   "homepage": "https://github.com/md-plugins",
   "bugs": {
     "url": "https://github.com/md-plugins/md-plugins/issues"
   },
+  "license": "MIT",
+  "author": "hawkeye64 <galbraith64@gmail.com>",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/md-plugins/md-plugins.git"
   },
-  "license": "MIT",
-  "author": "hawkeye64 <galbraith64@gmail.com>",
+  "files": [
+    "./dist"
+  ],
   "type": "module",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "import": {
@@ -27,26 +32,19 @@
       }
     }
   },
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "./dist"
-  ],
-  "dependencies": {
-    "gray-matter": "^4.0.3",
-    "markdown-it": "^14.1.0",
-    "@md-plugins/shared": "0.1.0-alpha.9"
+  "publishConfig": {
+    "access": "public"
   },
   "devDependencies": {
-    "@types/markdown-it": "^14.1.2"
+    "@types/markdown-it": "^14.1.2",
+    "gray-matter": "^4.0.3",
+    "markdown-it": "^14.1.1",
+    "@md-plugins/shared": "0.1.0-beta.1"
   },
   "peerDependencies": {
     "gray-matter": "^4.0.3",
     "markdown-it": "^14.1.0"
   },
-  "publishConfig": {
-    "access": "public"
-  },
   "scripts": {
     "build": "unbuild",
     "clean": "rm -rf dist/ node_modules/",