@astrojs/markdoc 0.0.3 → 0.0.4

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
-@astrojs/markdoc:build: cache hit, replaying output 30bf30e6debacf79
-@astrojs/markdoc:build: 
-@astrojs/markdoc:build: > @astrojs/markdoc@0.0.3 build /home/runner/work/astro/astro/packages/integrations/markdoc
-@astrojs/markdoc:build: > astro-scripts build "src/**/*.ts" && tsc
-@astrojs/markdoc:build: 
+@astrojs/markdoc:build: cache hit, replaying output a6e7d1873a50f12c
+@astrojs/markdoc:build: 
+@astrojs/markdoc:build: > @astrojs/markdoc@0.0.4 build /home/runner/work/astro/astro/packages/integrations/markdoc
+@astrojs/markdoc:build: > astro-scripts build "src/**/*.ts" && tsc
+@astrojs/markdoc:build: 

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @astrojs/markdoc
 
+## 0.0.4
+
+### Patch Changes
+
+- [#6588](https://github.com/withastro/astro/pull/6588) [`f42f47dc6`](https://github.com/withastro/astro/commit/f42f47dc6a91cdb6534dab0ecbf9e8e85f00ba40) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Allow access to content collection entry information (including parsed frontmatter and the entry slug) from your Markdoc using the `$entry` variable:
+
+  ```mdx
+  ---
+  title: Hello Markdoc!
+  ---
+
+  # {% $entry.data.title %}
+  ```
+
+- [#6607](https://github.com/withastro/astro/pull/6607) [`86273b588`](https://github.com/withastro/astro/commit/86273b5881cc61ebee11d40280b4c0aba8f4bb2e) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Fix: Update Markdoc renderer internals to remove unneeded dependencies
+
+- [#6622](https://github.com/withastro/astro/pull/6622) [`b37b86540`](https://github.com/withastro/astro/commit/b37b865400e77e92878d7e150244acce47e933c6) Thanks [@paulrudy](https://github.com/paulrudy)! - Fix README instructions for installing Markdoc manually.
+
 ## 0.0.3
 
 ### Patch Changes

package/README.md

@@ -237,6 +237,20 @@ const { Content } = await entry.render();
 />
 ```
 
+### Access frontmatter and content collection information from your templates
+
+You can access content collection information from your Markdoc templates using the `$entry` variable. This includes the entry `slug`, `collection` name, and frontmatter `data` parsed by your content collection schema (if any). This example renders the `title` frontmatter property as a heading:
+
+```md
+---
+title: Welcome to Markdoc 👋
+---
+
+# {% $entry.data.title %}
+```
+
+The `$entry` object matches [the `CollectionEntry` type](https://docs.astro.build/en/reference/api-reference/#collection-entry-type), excluding the `.render()` property.
+
 ### Markdoc config
 
 The Markdoc integration accepts [all Markdoc configuration options](https://markdoc.dev/docs/config), including [tags](https://markdoc.dev/docs/tags) and [functions](https://markdoc.dev/docs/functions).
@@ -292,11 +306,11 @@ You will need to install the `@markdoc/markdoc` package into your project first:
 
 ```sh
 # Using NPM
-npx astro add @markdoc/markdoc
+npm install @markdoc/markdoc
 # Using Yarn
-yarn astro add @markdoc/markdoc
+yarn add @markdoc/markdoc
 # Using PNPM
-pnpm astro add @markdoc/markdoc
+pnpm add @markdoc/markdoc
 ```
 
 Now, you can define Markdoc configuration options using `Markdock.transform()`.

package/components/Renderer.astro

@@ -2,8 +2,7 @@
 import type { RenderableTreeNode } from '@markdoc/markdoc';
 import type { AstroInstance } from 'astro';
 import { validateComponentsProp } from '../dist/utils.js';
-import { createAstroNode } from './astroNode';
-import RenderNode from './RenderNode.astro';
+import { ComponentNode, createTreeNode } from './TreeNode.js';
 
 type Props = {
 	content: RenderableTreeNode;
@@ -18,4 +17,4 @@ if (components) {
 }
 ---
 
-<RenderNode node={createAstroNode(content, components)} />
+<ComponentNode treeNode={createTreeNode(content, components)} />

package/components/TreeNode.ts

@@ -0,0 +1,82 @@
+import type { AstroInstance } from 'astro';
+import type { RenderableTreeNode } from '@markdoc/markdoc';
+import { createComponent, renderComponent, render } from 'astro/runtime/server/index.js';
+import Markdoc from '@markdoc/markdoc';
+import { MarkdocError, isCapitalized } from '../dist/utils.js';
+
+export type TreeNode =
+	| {
+			type: 'text';
+			content: string;
+	  }
+	| {
+			type: 'component';
+			component: AstroInstance['default'];
+			props: Record<string, any>;
+			children: TreeNode[];
+	  }
+	| {
+			type: 'element';
+			tag: string;
+			attributes: Record<string, any>;
+			children: TreeNode[];
+	  };
+
+export const ComponentNode = createComponent({
+	factory(result: any, { treeNode }: { treeNode: TreeNode }) {
+		if (treeNode.type === 'text') return render`${treeNode.content}`;
+		const slots = {
+			default: () =>
+				render`${treeNode.children.map((child) =>
+					renderComponent(result, 'ComponentNode', ComponentNode, { treeNode: child })
+				)}`,
+		};
+		if (treeNode.type === 'component') {
+			return renderComponent(
+				result,
+				treeNode.component.name,
+				treeNode.component,
+				treeNode.props,
+				slots
+			);
+		}
+		return renderComponent(result, treeNode.tag, treeNode.tag, treeNode.attributes, slots);
+	},
+	propagation: 'none',
+});
+
+export function createTreeNode(
+	node: RenderableTreeNode,
+	components: Record<string, AstroInstance['default']> = {}
+): TreeNode {
+	if (typeof node === 'string' || typeof node === 'number') {
+		return { type: 'text', content: String(node) };
+	} else if (node === null || typeof node !== 'object' || !Markdoc.Tag.isTag(node)) {
+		return { type: 'text', content: '' };
+	}
+
+	if (node.name in components) {
+		const component = components[node.name];
+		const props = node.attributes;
+		const children = node.children.map((child) => createTreeNode(child, components));
+
+		return {
+			type: 'component',
+			component,
+			props,
+			children,
+		};
+	} else if (isCapitalized(node.name)) {
+		throw new MarkdocError({
+			message: `Unable to render ${JSON.stringify(node.name)}.`,
+			hint: 'Did you add this to the "components" prop on your <Content /> component?',
+		});
+	} else {
+		return {
+			type: 'element',
+			tag: node.name,
+			attributes: node.attributes,
+			children: node.children.map((child) => createTreeNode(child, components)),
+		};
+	}
+}

package/dist/index.js

@@ -1,12 +1,7 @@
 import Markdoc from "@markdoc/markdoc";
 import fs from "node:fs";
 import { fileURLToPath } from "node:url";
-import {
-  getAstroConfigPath,
-  MarkdocError,
-  parseFrontmatter,
-  prependForwardSlash
-} from "./utils.js";
+import { getAstroConfigPath, MarkdocError, parseFrontmatter } from "./utils.js";
 function markdoc(markdocConfig = {}) {
   return {
     name: "@astrojs/markdoc",
@@ -25,38 +20,31 @@ function markdoc(markdocConfig = {}) {
         addContentEntryType({
           extensions: [".mdoc"],
           getEntryInfo,
+          getRenderModule({ entry }) {
+            validateRenderProperties(markdocConfig, config);
+            const ast = Markdoc.parse(entry.body);
+            const content = Markdoc.transform(ast, {
+              ...markdocConfig,
+              variables: {
+                ...markdocConfig.variables,
+                entry
+              }
+            });
+            return {
+              code: `import { jsx as h } from 'astro/jsx-runtime';
+import { Renderer } from '@astrojs/markdoc/components';
+const transformedContent = ${JSON.stringify(
+                content
+              )};
+export async function Content ({ components }) { return h(Renderer, { content: transformedContent, components }); }
+Content[Symbol.for('astro.needsHeadRendering')] = true;`
+            };
+          },
           contentModuleTypes: await fs.promises.readFile(
             new URL("../template/content-module-types.d.ts", import.meta.url),
             "utf-8"
           )
         });
-        const viteConfig = {
-          plugins: [
-            {
-              name: "@astrojs/markdoc",
-              async transform(code, id) {
-                if (!id.endsWith(".mdoc"))
-                  return;
-                validateRenderProperties(markdocConfig, config);
-                const body = getEntryInfo({
-                  // Can't use `pathToFileUrl` - Vite IDs are not plain file paths
-                  fileUrl: new URL(prependForwardSlash(id), "file://"),
-                  contents: code
-                }).body;
-                const ast = Markdoc.parse(body);
-                const content = Markdoc.transform(ast, markdocConfig);
-                return `import { jsx as h } from 'astro/jsx-runtime';
-import { Renderer } from '@astrojs/markdoc/components';
-const transformedContent = ${JSON.stringify(
-                  content
-                )};
-export async function Content ({ components }) { return h(Renderer, { content: transformedContent, components }); }
-Content[Symbol.for('astro.needsHeadRendering')] = true;`;
-              }
-            }
-          ]
-        };
-        updateConfig({ vite: viteConfig });
       }
     }
   };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@astrojs/markdoc",
   "description": "Add support for Markdoc pages in your Astro site",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "type": "module",
   "types": "./dist/index.d.ts",
   "author": "withastro",
@@ -26,14 +26,13 @@
   "dependencies": {
     "@markdoc/markdoc": "^0.2.2",
     "gray-matter": "^4.0.3",
-    "stringify-attributes": "^3.0.0",
     "zod": "^3.17.3"
   },
   "devDependencies": {
     "@types/chai": "^4.3.1",
     "@types/html-escaper": "^3.0.0",
     "@types/mocha": "^9.1.1",
-    "astro": "2.1.4",
+    "astro": "2.1.5",
     "astro-scripts": "0.0.14",
     "chai": "^4.3.6",
     "devalue": "^4.2.0",

package/src/index.ts

@@ -3,13 +3,7 @@ import Markdoc from '@markdoc/markdoc';
 import type { AstroConfig, AstroIntegration, ContentEntryType, HookParameters } from 'astro';
 import fs from 'node:fs';
 import { fileURLToPath } from 'node:url';
-import type { InlineConfig } from 'vite';
-import {
-	getAstroConfigPath,
-	MarkdocError,
-	parseFrontmatter,
-	prependForwardSlash,
-} from './utils.js';
+import { getAstroConfigPath, MarkdocError, parseFrontmatter } from './utils.js';
 
 type SetupHookParams = HookParameters<'astro:config:setup'> & {
 	// `contentEntryType` is not a public API
@@ -36,36 +30,27 @@ export default function markdoc(markdocConfig: Config = {}): AstroIntegration {
 				addContentEntryType({
 					extensions: ['.mdoc'],
 					getEntryInfo,
+					getRenderModule({ entry }) {
+						validateRenderProperties(markdocConfig, config);
+						const ast = Markdoc.parse(entry.body);
+						const content = Markdoc.transform(ast, {
+							...markdocConfig,
+							variables: {
+								...markdocConfig.variables,
+								entry,
+							},
+						});
+						return {
+							code: `import { jsx as h } from 'astro/jsx-runtime';\nimport { Renderer } from '@astrojs/markdoc/components';\nconst transformedContent = ${JSON.stringify(
+								content
+							)};\nexport async function Content ({ components }) { return h(Renderer, { content: transformedContent, components }); }\nContent[Symbol.for('astro.needsHeadRendering')] = true;`,
+						};
+					},
 					contentModuleTypes: await fs.promises.readFile(
 						new URL('../template/content-module-types.d.ts', import.meta.url),
 						'utf-8'
 					),
 				});
-
-				const viteConfig: InlineConfig = {
-					plugins: [
-						{
-							name: '@astrojs/markdoc',
-							async transform(code, id) {
-								if (!id.endsWith('.mdoc')) return;
-
-								validateRenderProperties(markdocConfig, config);
-								const body = getEntryInfo({
-									// Can't use `pathToFileUrl` - Vite IDs are not plain file paths
-									fileUrl: new URL(prependForwardSlash(id), 'file://'),
-									contents: code,
-								}).body;
-								const ast = Markdoc.parse(body);
-								const content = Markdoc.transform(ast, markdocConfig);
-
-								return `import { jsx as h } from 'astro/jsx-runtime';\nimport { Renderer } from '@astrojs/markdoc/components';\nconst transformedContent = ${JSON.stringify(
-									content
-								)};\nexport async function Content ({ components }) { return h(Renderer, { content: transformedContent, components }); }\nContent[Symbol.for('astro.needsHeadRendering')] = true;`;
-							},
-						},
-					],
-				};
-				updateConfig({ vite: viteConfig });
 			},
 		},
 	};

package/test/entry-prop.test.js

@@ -0,0 +1,58 @@
+import { parseHTML } from 'linkedom';
+import { expect } from 'chai';
+import { loadFixture } from '../../../astro/test/test-utils.js';
+import markdoc from '../dist/index.js';
+
+const root = new URL('./fixtures/entry-prop/', import.meta.url);
+
+describe('Markdoc - Entry prop', () => {
+	let baseFixture;
+
+	before(async () => {
+		baseFixture = await loadFixture({
+			root,
+			integrations: [markdoc()],
+		});
+	});
+
+	describe('dev', () => {
+		let devServer;
+
+		before(async () => {
+			devServer = await baseFixture.startDevServer();
+		});
+
+		after(async () => {
+			await devServer.stop();
+		});
+
+		it('has expected entry properties', async () => {
+			const res = await baseFixture.fetch('/');
+			const html = await res.text();
+			const { document } = parseHTML(html);
+			expect(document.querySelector('h1')?.textContent).to.equal('Processed by schema: Test entry');
+			expect(document.getElementById('id')?.textContent?.trim()).to.equal('id: entry.mdoc');
+			expect(document.getElementById('slug')?.textContent?.trim()).to.equal('slug: entry');
+			expect(document.getElementById('collection')?.textContent?.trim()).to.equal(
+				'collection: blog'
+			);
+		});
+	});
+
+	describe('build', () => {
+		before(async () => {
+			await baseFixture.build();
+		});
+
+		it('has expected entry properties', async () => {
+			const html = await baseFixture.readFile('/index.html');
+			const { document } = parseHTML(html);
+			expect(document.querySelector('h1')?.textContent).to.equal('Processed by schema: Test entry');
+			expect(document.getElementById('id')?.textContent?.trim()).to.equal('id: entry.mdoc');
+			expect(document.getElementById('slug')?.textContent?.trim()).to.equal('slug: entry');
+			expect(document.getElementById('collection')?.textContent?.trim()).to.equal(
+				'collection: blog'
+			);
+		});
+	});
+});

package/test/fixtures/entry-prop/astro.config.mjs

@@ -0,0 +1,7 @@
+import { defineConfig } from 'astro/config';
+import markdoc from '@astrojs/markdoc';
+
+// https://astro.build/config
+export default defineConfig({
+	integrations: [markdoc()],
+});

package/test/fixtures/entry-prop/node_modules/.bin/astro

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/astro/astro/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/astro/astro/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../../../astro/astro.js" "$@"
+else
+  exec node  "$basedir/../../../../../../../astro/astro.js" "$@"
+fi

package/test/fixtures/entry-prop/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@test/markdoc-entry-prop",
+  "version": "0.0.0",
+  "private": true,
+  "dependencies": {
+    "@astrojs/markdoc": "workspace:*",
+    "astro": "workspace:*"
+  }
+}

package/test/fixtures/entry-prop/src/content/blog/entry.mdoc

@@ -0,0 +1,9 @@
+---
+title: Test entry
+---
+
+# {% $entry.data.title %}
+
+- id: {% $entry.id %} {% #id %}
+- slug: {% $entry.slug %} {% #slug %}
+- collection: {% $entry.collection %} {% #collection %}

package/test/fixtures/entry-prop/src/content/config.ts

@@ -0,0 +1,9 @@
+import { defineCollection, z } from 'astro:content';
+
+const blog = defineCollection({
+	schema: z.object({
+		title: z.string().transform(v => 'Processed by schema: ' + v),
+	}),
+});
+
+export const collections = { blog }

package/test/fixtures/entry-prop/src/pages/index.astro

@@ -0,0 +1,19 @@
+---
+import { getEntryBySlug } from 'astro:content';
+
+const entry = await getEntryBySlug('blog', 'entry');
+const { Content } = await entry.render();
+---
+
+<html lang="en">
+	<head>
+		<meta charset="utf-8" />
+		<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
+		<meta name="viewport" content="width=device-width" />
+		<meta name="generator" content={Astro.generator} />
+		<title>Astro</title>
+	</head>
+	<body>
+		<Content />
+	</body>
+</html>

package/components/RenderNode.astro

@@ -1,30 +0,0 @@
----
-import stringifyAttributes from 'stringify-attributes';
-import type { AstroNode } from './astroNode';
-
-type Props = {
-	node: AstroNode;
-};
-
-const Node = (Astro.props as Props).node;
----
-
-{
-	typeof Node === 'string' ? (
-		<Fragment set:text={Node} />
-	) : 'component' in Node ? (
-		<Node.component {...Node.props}>
-			{Node.children.map((child) => (
-				<Astro.self node={child} />
-			))}
-		</Node.component>
-	) : (
-		<Fragment>
-			<Fragment set:html={`<${Node.tag} ${stringifyAttributes(Node.attributes)}>`} />
-			{Node.children.map((child) => (
-				<Astro.self node={child} />
-			))}
-			<Fragment set:html={`</${Node.tag}>`} />
-		</Fragment>
-	)
-}

package/components/astroNode.ts

@@ -1,51 +0,0 @@
-import type { AstroInstance } from 'astro';
-import type { RenderableTreeNode } from '@markdoc/markdoc';
-import Markdoc from '@markdoc/markdoc';
-import { MarkdocError, isCapitalized } from '../dist/utils.js';
-
-export type AstroNode =
-	| string
-	| {
-			component: AstroInstance['default'];
-			props: Record<string, any>;
-			children: AstroNode[];
-	  }
-	| {
-			tag: string;
-			attributes: Record<string, any>;
-			children: AstroNode[];
-	  };
-
-export function createAstroNode(
-	node: RenderableTreeNode,
-	components: Record<string, AstroInstance['default']> = {}
-): AstroNode {
-	if (typeof node === 'string' || typeof node === 'number') {
-		return String(node);
-	} else if (node === null || typeof node !== 'object' || !Markdoc.Tag.isTag(node)) {
-		return '';
-	}
-
-	if (node.name in components) {
-		const component = components[node.name];
-		const props = node.attributes;
-		const children = node.children.map((child) => createAstroNode(child, components));
-
-		return {
-			component,
-			props,
-			children,
-		};
-	} else if (isCapitalized(node.name)) {
-		throw new MarkdocError({
-			message: `Unable to render ${JSON.stringify(node.name)}.`,
-			hint: 'Did you add this to the "components" prop on your <Content /> component?',
-		});
-	} else {
-		return {
-			tag: node.name,
-			attributes: node.attributes,
-			children: node.children.map((child) => createAstroNode(child, components)),
-		};
-	}
-}