feat(core): add markdownEnv to Page

vuepress · Jan 7, 2023 · b04c6da · b04c6da
1 parent b4e313b
commit b04c6da
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 0 deletions.
diff --git a/packages/core/src/page/createPage.ts b/packages/core/src/page/createPage.ts
@@ -37,6 +37,7 @@ export const createPage = async (
     frontmatter,
     headers,
     links,
+    markdownEnv,
     sfcBlocks,
     title,
   } = await renderPageContent({
@@ -123,6 +124,7 @@ export const createPage = async (
     date,
     deps,
     links,
+    markdownEnv,
     pathInferred,
     pathLocale,
     permalink,

diff --git a/packages/core/src/page/renderPageContent.ts b/packages/core/src/page/renderPageContent.ts
@@ -24,6 +24,7 @@ export const renderPageContent = async ({
 }): Promise<{
   contentRendered: string
   deps: string[]
+  markdownEnv: Record<string, unknown>
   frontmatter: PageFrontmatter
   headers: MarkdownHeader[]
   links: MarkdownLink[]
@@ -54,6 +55,19 @@ export const renderPageContent = async ({
       customBlocks: [],
     },
     title = '',
+
+    // values dropped from env
+
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    base: _base,
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    content: _content,
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    filePath: _filePath,
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    filePathRelative: _filePathRelative,
+
+    ...otherEnv
   } = markdownEnv
 
   return {
@@ -62,6 +76,7 @@ export const renderPageContent = async ({
     frontmatter,
     headers,
     links,
+    markdownEnv: otherEnv,
     sfcBlocks,
     title: frontmatter.title ?? title,
   }

diff --git a/packages/core/src/types/page.ts b/packages/core/src/types/page.ts
@@ -74,6 +74,11 @@ export type Page<
      */
     routeMeta: Record<string, unknown>
 
+    /**
+     * Markdown Environment of the page
+     */
+    markdownEnv: Record<string, unknown>
+
     /**
      * Extracted sfc blocks of the page
      */

diff --git a/packages/core/tests/page/renderPageContent.spec.ts b/packages/core/tests/page/renderPageContent.spec.ts
@@ -31,6 +31,7 @@ const msg = 'msg'
       frontmatter: {},
       headers: [],
       links: [],
+      markdownEnv: { excerpt: '' },
       sfcBlocks: {
         template: {
           type: 'template',