@astrojs/markdoc 0.0.0-markdoc-20230214163516

package/LICENSE

@@ -0,0 +1,61 @@
+MIT License
+
+Copyright (c) 2021 Fred K. Schott
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
+"""
+This license applies to parts of the `packages/create-astro` and `packages/astro` subdirectories originating from the https://github.com/sveltejs/kit repository:
+
+Copyright (c) 2020 [these people](https://github.com/sveltejs/kit/graphs/contributors)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+"""
+
+
+"""
+This license applies to parts of the `packages/create-astro` and `packages/astro` subdirectories originating from the https://github.com/vitejs/vite repository:
+
+MIT License
+
+Copyright (c) 2019-present, Yuxi (Evan) You and Vite contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""

package/README.md

@@ -0,0 +1,160 @@
+# @astrojs/markdoc (experimental) 📝
+
+This **[Astro integration][astro-integration]** enables the usage of [Markdoc](https://markdoc.dev/) to create components, pages, and content collection entries.
+
+- <strong>[Why Markdoc?](#why-markdoc)</strong>
+- <strong>[Installation](#installation)</strong>
+- <strong>[Usage](#usage)</strong>
+- <strong>[Configuration](#configuration)</strong>
+- <strong>[Examples](#examples)</strong>
+- <strong>[Troubleshooting](#troubleshooting)</strong>
+- <strong>[Contributing](#contributing)</strong>
+- <strong>[Changelog](#changelog)</strong>
+
+## Why Markdoc?
+
+Markdoc allows you to enhance your Markdown with [UI components][astro-ui-frameworks]. If you have existing content authored in Markdoc, this integration allows you to bring those files to your Astro project using content collections.
+
+## Installation
+
+### Quick Install
+
+The `astro add` command-line tool automates the installation for you. Run one of the following commands in a new terminal window. (If you aren't sure which package manager you're using, run the first command.) Then, follow the prompts, and type "y" in the terminal (meaning "yes") for each one.
+
+```sh
+# Using NPM
+npx astro add markdoc
+# Using Yarn
+yarn astro add markdoc
+# Using PNPM
+pnpm astro add markdoc
+```
+
+If you run into any issues, [feel free to report them to us on GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below.
+
+### Manual Install
+
+First, install the `@astrojs/markdoc` package using your package manager. If you're using npm or aren't sure, run this in the terminal:
+
+```sh
+npm install @astrojs/markdoc
+```
+
+Then, apply this integration to your `astro.config.*` file using the `integrations` property:
+
+__`astro.config.mjs`__
+
+```js ins={2} "markdoc()"
+import { defineConfig } from 'astro/config';
+import markdoc from '@astrojs/markdoc';
+
+export default defineConfig({
+  // ...
+  integrations: [markdoc()],
+});
+```
+
+## Usage
+
+Markdoc files can be used within content collections. Add entries to any content collection using the `.mdoc` extension:
+
+```sh
+src/content/docs/
+  why-markdoc.mdoc
+  quick-start.mdoc
+```
+
+Then, query for these files using the [Content Collection APIs](https://docs.astro.build/en/guides/content-collections/#querying-collections):
+
+```astro
+---
+import { getEntryBySlug } from 'astro:content';
+
+const entry = await getEntryBySlug('docs', 'why-markdoc');
+const { Content } = await entry.render();
+---
+
+<!--Access frontmatter properties with `data`-->
+<h1>{entry.data.title}</h1>
+<!--Render Markdoc contents with the Content component-->
+<Content />
+```
+
+📚 See the [Astro Content Collection docs][astro-content-collections] for more information.
+
+## Configuration
+
+You can configure how your Markdoc content is rendered using props via the `Content` component. This component is returned by [a content collection `render()` result](https://docs.astro.build/en/guides/content-collections/#rendering-content-to-html).
+
+### `config` prop
+
+The `config` prop accepts all [Markdoc configuration options](https://markdoc.dev/docs/config#full-example), including tags and variables.
+
+This example defines a `version` variable to use within a `why-markdoc.mdoc` entry:
+
+```astro
+---
+import { getEntryBySlug } from 'astro:content';
+
+const entry = await getEntryBySlug('docs', 'why-markdoc');
+const { Content } = await entry.render();
+---
+
+<Content
+  config={{
+    variables: {
+      version: '0.0.1',
+    }
+  }}
+/>
+```
+
+### `components` prop
+
+The `components` prop defines mappings from an HTML element name to an Astro or UI framework component (React, Vue, Svelte, etc).
+
+:::note
+`components` does not support the `client:` directive for hydrating components. To embed client-side components, create a wrapper `.astro` file to import your component and apply a `client:` directive manually.
+:::
+
+This example renders all `h1` headings using a `Title` component:
+
+```astro
+---
+import { getEntryBySlug } from 'astro:content';
+import Title from '../components/Title.astro';
+
+const entry = await getEntryBySlug('docs', 'why-markdoc');
+const { Content } = await entry.render();
+---
+
+<Content
+  components={{
+    h1: Title,
+  }}
+/>
+```
+
+## Examples
+
+*   The [Astro Markdoc starter template](https://github.com/withastro/astro/tree/latest/examples/with-mdx) shows how to use Markdoc files in your Astro project.
+
+## Troubleshooting
+
+For help, check out the `#support` channel on [Discord](https://astro.build/chat). Our friendly Support Squad members are here to help!
+
+You can also check our [Astro Integration Documentation][astro-integration] for more on integrations.
+
+## Contributing
+
+This package is maintained by Astro's Core team. You're welcome to submit an issue or PR!
+
+## Changelog
+
+See [CHANGELOG.md](https://github.com/withastro/astro/tree/main/packages/integrations/markdoc/CHANGELOG.md) for a history of changes to this integration.
+
+[astro-integration]: https://docs.astro.build/en/guides/integrations-guide/
+
+[astro-ui-frameworks]: https://docs.astro.build/en/core-concepts/framework-components/#using-framework-components
+
+[astro-content-collections]: https://docs.astro.build/en/guides/content-collections/

package/components/RenderNode.astro

@@ -0,0 +1,30 @@
+---
+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/Renderer.astro

@@ -0,0 +1,14 @@
+---
+import type { RenderableTreeNode } from '@markdoc/markdoc';
+import { ComponentRenderer, createAstroNode } from './astroNode';
+import RenderNode from './RenderNode.astro';
+
+type Props = {
+	content: RenderableTreeNode;
+	components: Record<string, ComponentRenderer>;
+};
+
+const { content, components } = Astro.props as Props;
+---
+
+<RenderNode node={createAstroNode(content, components)} />

package/components/astroNode.ts

@@ -0,0 +1,64 @@
+import type { ComponentInstance } from 'astro';
+import type { RenderableTreeNode, Tag } from '@markdoc/markdoc';
+import Markdoc from '@markdoc/markdoc';
+import { escape } from 'html-escaper';
+
+export type ComponentRenderer =
+	| ComponentInstance['default']
+	| {
+			component: ComponentInstance['default'];
+			props?(params: { attributes: Record<string, any>; getTreeNode(): Tag }): Record<string, any>;
+	  };
+
+export type AstroNode =
+	| string
+	| {
+			component: ComponentInstance['default'];
+			props: Record<string, any>;
+			children: AstroNode[];
+	  }
+	| {
+			tag: string;
+			attributes: Record<string, any>;
+			children: AstroNode[];
+	  };
+
+export function createAstroNode(
+	node: RenderableTreeNode,
+	components: Record<string, ComponentRenderer> = {}
+): AstroNode {
+	if (typeof node === 'string' || typeof node === 'number') {
+		return escape(String(node));
+	} else if (node === null || typeof node !== 'object' || !Markdoc.Tag.isTag(node)) {
+		return '';
+	}
+
+	if (node.name in components) {
+		const componentRenderer = components[node.name];
+		const component =
+			'component' in componentRenderer ? componentRenderer.component : componentRenderer;
+		const props =
+			'props' in componentRenderer && typeof componentRenderer.props === 'function'
+				? componentRenderer.props({
+						attributes: node.attributes,
+						getTreeNode() {
+							return node;
+						},
+				  })
+				: node.attributes;
+
+		const children = node.children.map((child) => createAstroNode(child, components));
+
+		return {
+			component,
+			props,
+			children,
+		};
+	} else {
+		return {
+			tag: node.name,
+			attributes: node.attributes,
+			children: node.children.map((child) => createAstroNode(child, components)),
+		};
+	}
+}

package/components/index.ts

@@ -0,0 +1,2 @@
+// @ts-ignore
+export { default as Renderer } from './Renderer.astro';

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import type { AstroIntegration } from 'astro';
+import _Markdoc from '@markdoc/markdoc';
+export default function markdoc(): AstroIntegration;
+export declare const Markdoc: typeof _Markdoc;

package/dist/index.js

@@ -0,0 +1,57 @@
+import _Markdoc from "@markdoc/markdoc";
+import { parseFrontmatter } from "./utils.js";
+import { fileURLToPath } from "node:url";
+import fs from "node:fs";
+function markdoc() {
+  return {
+    name: "@astrojs/markdoc",
+    hooks: {
+      "astro:config:setup": async ({ updateConfig, config, addContentEntryType, command }) => {
+        const contentEntryType = {
+          extensions: [".mdoc"],
+          async getEntryInfo({ fileUrl, contents }) {
+            const parsed = parseFrontmatter(contents, fileURLToPath(fileUrl));
+            return {
+              data: parsed.data,
+              body: parsed.content,
+              slug: parsed.data.slug,
+              rawData: parsed.matter
+            };
+          },
+          contentModuleTypes: await fs.promises.readFile(
+            new URL("../template/content-module-types.d.ts", import.meta.url),
+            "utf-8"
+          )
+        };
+        addContentEntryType(contentEntryType);
+        const viteConfig = {
+          plugins: [
+            {
+              name: "@astrojs/markdoc",
+              async transform(code, id) {
+                if (!id.endsWith(".mdoc"))
+                  return;
+                return `import { jsx as h } from 'astro/jsx-runtime';
+import { Markdoc } from '@astrojs/markdoc';
+import { Renderer } from '@astrojs/markdoc/components';
+export const body = ${JSON.stringify(
+                  code
+                )};
+export function getParsed() { return Markdoc.parse(body); }
+export function getTransformed(inlineConfig) { return Markdoc.transform(getParsed(), inlineConfig) }
+export async function Content ({ config, components }) { return h(Renderer, { content: getTransformed(config), components }); }
+Content[Symbol.for('astro.needsHeadRendering')] = true;`;
+              }
+            }
+          ]
+        };
+        updateConfig({ vite: viteConfig });
+      }
+    }
+  };
+}
+const Markdoc = _Markdoc;
+export {
+  Markdoc,
+  markdoc as default
+};

package/dist/utils.d.ts

@@ -0,0 +1,6 @@
+import matter from 'gray-matter';
+/**
+ * Match YAML exception handling from Astro core errors
+ * @see 'astro/src/core/errors.ts'
+ */
+export declare function parseFrontmatter(fileContents: string, filePath: string): matter.GrayMatterFile<string>;

package/dist/utils.js

@@ -0,0 +1,20 @@
+import matter from "gray-matter";
+function parseFrontmatter(fileContents, filePath) {
+  try {
+    matter.clearCache();
+    return matter(fileContents);
+  } catch (e) {
+    if (e.name === "YAMLException") {
+      const err = e;
+      err.id = filePath;
+      err.loc = { file: e.id, line: e.mark.line + 1, column: e.mark.column };
+      err.message = e.reason;
+      throw err;
+    } else {
+      throw e;
+    }
+  }
+}
+export {
+  parseFrontmatter
+};

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@astrojs/markdoc",
+  "description": "Use Markdoc within Astro",
+  "version": "0.0.0-markdoc-20230214163516",
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "author": "withastro",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/withastro/astro.git",
+    "directory": "packages/integrations/markdoc"
+  },
+  "keywords": [
+    "astro-integration",
+    "astro-component",
+    "markdoc"
+  ],
+  "bugs": "https://github.com/withastro/astro/issues",
+  "homepage": "https://docs.astro.build/en/guides/integrations-guide/markdoc/",
+  "exports": {
+    ".": "./dist/index.js",
+    "./components": "./components/index.ts",
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@markdoc/markdoc": "^0.2.2",
+    "gray-matter": "^4.0.3",
+    "html-escaper": "^3.0.3",
+    "stringify-attributes": "^3.0.0"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.3.1",
+    "@types/html-escaper": "^3.0.0",
+    "@types/mocha": "^9.1.1",
+    "astro": "0.0.0-markdoc-20230214163516",
+    "astro-scripts": "0.0.10",
+    "chai": "^4.3.6",
+    "devalue": "^4.2.0",
+    "linkedom": "^0.14.12",
+    "mocha": "^9.2.2",
+    "vite": "^4.0.3"
+  },
+  "engines": {
+    "node": ">=16.12.0"
+  },
+  "scripts": {
+    "build": "astro-scripts build \"src/**/*.ts\" && tsc",
+    "build:ci": "astro-scripts build \"src/**/*.ts\"",
+    "dev": "astro-scripts dev \"src/**/*.ts\"",
+    "test": "mocha --exit --timeout 20000",
+    "test:match": "mocha --timeout 20000 -g"
+  }
+}

package/src/index.ts

@@ -0,0 +1,50 @@
+import type { AstroIntegration } from 'astro';
+import type { InlineConfig } from 'vite';
+import _Markdoc from '@markdoc/markdoc';
+import { parseFrontmatter } from './utils.js';
+import { fileURLToPath } from 'node:url';
+import fs from 'node:fs';
+
+export default function markdoc(): AstroIntegration {
+	return {
+		name: '@astrojs/markdoc',
+		hooks: {
+			'astro:config:setup': async ({ updateConfig, config, addContentEntryType, command }: any) => {
+				const contentEntryType = {
+					extensions: ['.mdoc'],
+					async getEntryInfo({ fileUrl, contents }: { fileUrl: URL; contents: string }) {
+						const parsed = parseFrontmatter(contents, fileURLToPath(fileUrl));
+						return {
+							data: parsed.data,
+							body: parsed.content,
+							slug: parsed.data.slug,
+							rawData: parsed.matter,
+						};
+					},
+					contentModuleTypes: await fs.promises.readFile(
+						new URL('../template/content-module-types.d.ts', import.meta.url),
+						'utf-8'
+					),
+				};
+				addContentEntryType(contentEntryType);
+
+				const viteConfig: InlineConfig = {
+					plugins: [
+						{
+							name: '@astrojs/markdoc',
+							async transform(code, id) {
+								if (!id.endsWith('.mdoc')) return;
+								return `import { jsx as h } from 'astro/jsx-runtime';\nimport { Markdoc } from '@astrojs/markdoc';\nimport { Renderer } from '@astrojs/markdoc/components';\nexport const body = ${JSON.stringify(
+									code
+								)};\nexport function getParsed() { return Markdoc.parse(body); }\nexport function getTransformed(inlineConfig) { return Markdoc.transform(getParsed(), inlineConfig) }\nexport async function Content ({ config, components }) { return h(Renderer, { content: getTransformed(config), components }); }\nContent[Symbol.for('astro.needsHeadRendering')] = true;`;
+							},
+						},
+					],
+				};
+				updateConfig({ vite: viteConfig });
+			},
+		},
+	};
+}
+
+export const Markdoc = _Markdoc;

package/src/utils.ts

@@ -0,0 +1,25 @@
+import matter from 'gray-matter';
+import type { ErrorPayload as ViteErrorPayload } from 'vite';
+
+/**
+ * Match YAML exception handling from Astro core errors
+ * @see 'astro/src/core/errors.ts'
+ */
+export function parseFrontmatter(fileContents: string, filePath: string) {
+	try {
+		// `matter` is empty string on cache results
+		// clear cache to prevent this
+		(matter as any).clearCache();
+		return matter(fileContents);
+	} catch (e: any) {
+		if (e.name === 'YAMLException') {
+			const err: Error & ViteErrorPayload['err'] = e;
+			err.id = filePath;
+			err.loc = { file: e.id, line: e.mark.line + 1, column: e.mark.column };
+			err.message = e.reason;
+			throw err;
+		} else {
+			throw e;
+		}
+	}
+}

package/template/content-module-types.d.ts

@@ -0,0 +1,20 @@
+declare module 'astro:content' {
+	type ComponentRenderer =
+		| import('astro').ComponentInstance['default']
+		| {
+				component: import('astro').ComponentInstance['default'];
+				props?(params: {
+					attributes: Record<string, any>;
+					getTreeNode(): import('@astrojs/markdoc').Markdoc.Tag;
+				}): Record<string, any>;
+		  };
+
+	interface Render {
+		'.mdoc': Promise<{
+			Content(props: {
+				config?: import('@astrojs/markdoc').Markdoc.Config;
+				components?: Record<string, ComponentRenderer>;
+			}): import('astro').MarkdownInstance<{}>['Content'];
+		}>;
+	}
+}