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

package/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024-present, Jeff Galbraith
+Copyright (c) 2024-present, MD-PLUGINS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -79,7 +79,7 @@ The `md-plugin-frontmatter` plugin supports the following options:
 | Option            | Type    | Default | Description                                                                                    |
 | ----------------- | ------- | ------- | ---------------------------------------------------------------------------------------------- |
 | grayMatterOptions | object  | {}      | Options for the gray-matter library. Refer to the gray-matter documentation.                   |
-| renderExcerpt     | boolean | true    | Whether to render the excerpt as HTML. If false, the raw Markdown is extracted as the excerpt. |
+| renderExcerpt     | boolean | false   | Whether to render the excerpt as HTML. If false, the raw Markdown is extracted as the excerpt. |
 
 ## Advanced Usage
 
@@ -92,7 +92,7 @@ md.use(frontmatterPlugin, {
   grayMatterOptions: {
     delimiters: '+++', // Use "+++" as the frontmatter delimiter
   },
-});
+})
 ```
 
 ## Testing
@@ -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

@@ -15,7 +15,7 @@ interface FrontmatterPluginOptions {
     /**
      * Render the excerpt or not
      *
-     * @default true
+     * @default false
      */
     renderExcerpt?: boolean;
 }
@@ -25,6 +25,10 @@ declare module '@md-plugins/shared' {
          * The raw Markdown content without frontmatter
          */
         content?: string;
+        /**
+         * Whether render excerpt or not
+         */
+        renderExcerpt?: boolean;
         /**
          * The excerpt that extracted by `md-plugin-frontmatter`
          *

package/dist/index.d.ts

@@ -15,7 +15,7 @@ interface FrontmatterPluginOptions {
     /**
      * Render the excerpt or not
      *
-     * @default true
+     * @default false
      */
     renderExcerpt?: boolean;
 }
@@ -25,6 +25,10 @@ declare module '@md-plugins/shared' {
          * The raw Markdown content without frontmatter
          */
         content?: string;
+        /**
+         * Whether render excerpt or not
+         */
+        renderExcerpt?: boolean;
         /**
          * The excerpt that extracted by `md-plugin-frontmatter`
          *

package/dist/index.mjs

@@ -1,10 +1,11 @@
 import grayMatter from 'gray-matter';
 
-const frontmatterPlugin = (md, { grayMatterOptions, renderExcerpt = true } = {}) => {
+const frontmatterPlugin = (md, { grayMatterOptions, renderExcerpt = false } = {}) => {
   const render = md.render.bind(md);
   md.render = (src, env = {}) => {
     let data, content, excerpt;
     try {
+      ;
       ({ data, content } = grayMatter(src, grayMatterOptions));
     } catch (error) {
       console.error("Failed to parse frontmatter:", error);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@md-plugins/md-plugin-frontmatter",
-  "version": "0.1.0-alpha.1",
+  "version": "0.1.0-alpha.11",
   "description": "A markdown-it plugin for handling frontmatter in markdown files.",
   "keywords": [
     "markdown-it",
@@ -33,17 +33,23 @@
     "./dist"
   ],
   "dependencies": {
-    "@types/markdown-it": "^14.1.2",
     "gray-matter": "^4.0.3",
     "markdown-it": "^14.1.0",
-    "@md-plugins/shared": "0.1.0-alpha.1"
+    "@md-plugins/shared": "0.1.0-alpha.11"
+  },
+  "devDependencies": {
+    "@types/markdown-it": "^14.1.2"
+  },
+  "peerDependencies": {
+    "gray-matter": "^4.0.3",
+    "markdown-it": "^14.1.0"
   },
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
     "build": "unbuild",
-    "clean": "rm -rf dist",
+    "clean": "rm -rf dist/ node_modules/",
     "test": "vitest"
   }
 }