@mdit-vue/plugin-frontmatter 0.6.0 → 0.7.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.7.0](https://github.com/mdit-vue/mdit-vue/compare/v0.6.0...v0.7.0) (2022-07-18)
+
+### Features
+
+- **plugin-frontmatter:** extract content without frontmatter into `env.content` ([a9d5cef](https://github.com/mdit-vue/mdit-vue/commit/a9d5cef9b791bad122cd6e86af0905cab8c2b583))
+
 # [0.6.0](https://github.com/mdit-vue/mdit-vue/compare/v0.5.0...v0.6.0) (2022-07-11)
 
 ### Features

package/README.md

@@ -7,6 +7,7 @@ A [markdown-it](https://github.com/markdown-it/markdown-it) plugin to get markdo
 
 - Extract frontmatter into markdown-it `env.frontmatter`.
 - Allow providing default frontmatter via markdown-it `env.frontmatter`.
+- Extract markdown content without frontmatter into markdown-it `env.content`.
 - Support extracting rendered excerpt into markdown-it `env.excerpt`.
 
 ## Install
@@ -20,6 +21,7 @@ npm i @mdit-vue/plugin-frontmatter
 ```ts
 import MarkdownIt from 'markdown-it';
 import { frontmatterPlugin } from '@mdit-vue/plugin-frontmatter';
+import type { MarkdownItEnv } from '@mdit-vue/types';
 
 const md = MarkdownIt({ html: true }).use(frontmatterPlugin, {
   // options

package/dist/index.cjs

@@ -12,6 +12,7 @@ const frontmatterPlugin = (md, { grayMatterOptions, renderExcerpt = true } = {})
   const render = md.render.bind(md);
   md.render = (src, env = {}) => {
     const { data, content, excerpt = "" } = grayMatter__default(src, grayMatterOptions);
+    env.content = content;
     env.frontmatter = {
       ...env.frontmatter,
       ...data

package/dist/index.d.ts

@@ -14,12 +14,27 @@ interface FrontmatterPluginOptions {
     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>;
     }
 }

package/dist/index.mjs

@@ -4,6 +4,7 @@ const frontmatterPlugin = (md, { grayMatterOptions, renderExcerpt = true } = {})
   const render = md.render.bind(md);
   md.render = (src, env = {}) => {
     const { data, content, excerpt = "" } = grayMatter(src, grayMatterOptions);
+    env.content = content;
     env.frontmatter = {
       ...env.frontmatter,
       ...data

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mdit-vue/plugin-frontmatter",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "A markdown-it plugin to get markdown frontmatter",
   "keywords": [
     "markdown-it",
@@ -34,7 +34,7 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@mdit-vue/types": "0.6.0",
+    "@mdit-vue/types": "0.7.0",
     "@types/markdown-it": "^12.2.3",
     "gray-matter": "^4.0.3",
     "markdown-it": "^13.0.1"
@@ -42,10 +42,10 @@
   "devDependencies": {
     "c8": "^7.11.3",
     "unbuild": "^0.7.4",
-    "vitest": "^0.18.0"
+    "vitest": "^0.18.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "654a3a4d52f4fb9711bf5f7ba3674ff58ec663bf"
+  "gitHead": "dd30ddd75ca461f775ccc35556132851ebc5e58a"
 }

package/src/frontmatter-plugin.ts

@@ -16,6 +16,9 @@ export const frontmatterPlugin: PluginWithOptions<FrontmatterPluginOptions> = (
   md.render = (src, env: MarkdownItEnv = {}) => {
     const { data, content, excerpt = '' } = grayMatter(src, grayMatterOptions);
 
+    // extract stripped content
+    env.content = content;
+
     // extract frontmatter
     env.frontmatter = {
       // allow providing default value

package/src/types.ts

@@ -15,13 +15,30 @@ export interface FrontmatterPluginOptions {
 
   /**
    * 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>;
   }
 }

package/tests/frontmatter-plugin.spec.ts

@@ -8,6 +8,7 @@ const testCases: {
   source: string;
   options: FrontmatterPluginOptions;
   env: MarkdownItEnv;
+  content: MarkdownItEnv['content'];
   frontmatter: MarkdownItEnv['frontmatter'];
   excerpt: MarkdownItEnv['excerpt'];
 }[] = [
@@ -21,6 +22,7 @@ date: 2022-07-06
 `,
     options: {},
     env: {},
+    content: '',
     frontmatter: {
       str: 'string',
       num: 123,
@@ -42,6 +44,7 @@ bar: bar
         baz: 'default-baz',
       },
     },
+    content: '',
     frontmatter: {
       foo: 'foo',
       bar: 'bar',
@@ -56,6 +59,10 @@ bar: bar
 `,
     options: {},
     env: {},
+    content: `\
+# Hello, world
+---
+`,
     frontmatter: {},
     excerpt: '',
   },
@@ -75,6 +82,10 @@ bar: bar
       renderExcerpt: true,
     },
     env: {},
+    content: `\
+# Hello, world
+---
+`,
     frontmatter: {
       foo: 'foo',
       bar: 'bar',
@@ -98,6 +109,10 @@ bar: bar
       renderExcerpt: true,
     },
     env: {},
+    content: `\
+# Hello, world
+<!-- more -->
+`,
     frontmatter: {
       foo: 'foo',
       bar: 'bar',
@@ -121,6 +136,10 @@ bar: bar
       renderExcerpt: false,
     },
     env: {},
+    content: `\
+# Hello, world
+<!-- more -->
+`,
     frontmatter: {
       foo: 'foo',
       bar: 'bar',
@@ -131,11 +150,12 @@ bar: bar
 
 describe('@mdit-vue/plugin-frontmatter > frontmatter-plugin', () => {
   testCases.forEach(
-    ({ source, options, env: rawEnv, frontmatter, excerpt }, i) =>
+    ({ source, options, env: rawEnv, content, frontmatter, excerpt }, i) =>
       it(`case ${i}`, () => {
         const md = MarkdownIt().use(frontmatterPlugin, options);
         const env: MarkdownItEnv = { ...rawEnv };
         md.render(source, env);
+        expect(env.content).toEqual(content);
         expect(env.frontmatter).toEqual(frontmatter);
         expect(env.excerpt).toEqual(excerpt);
       }),