@astrojs/markdoc 0.2.0 → 0.2.1

package/dist/index.js

@@ -5,7 +5,7 @@ import { isValidUrl, MarkdocError, parseFrontmatter, prependForwardSlash } from
 import { emitESMImage } from "astro/assets";
 import { bold, red, yellow } from "kleur/colors";
 import { loadMarkdocConfig } from "./load-config.js";
-import { applyDefaultConfig } from "./runtime.js";
+import { setupConfig } from "./runtime.js";
 function markdocIntegration(legacyConfig) {
   if (legacyConfig) {
     console.log(
@@ -38,7 +38,7 @@ function markdocIntegration(legacyConfig) {
           async getRenderModule({ entry, viteId }) {
             const ast = Markdoc.parse(entry.body);
             const pluginContext = this;
-            const markdocConfig = applyDefaultConfig(userMarkdocConfig, entry);
+            const markdocConfig = setupConfig(userMarkdocConfig, entry);
             const validationErrors = Markdoc.validate(ast, markdocConfig).filter((e) => {
               return (
                 // Ignore `variable-undefined` errors.
@@ -71,7 +71,7 @@ function markdocIntegration(legacyConfig) {
             }
             const res = `import { jsx as h } from 'astro/jsx-runtime';
 						import { Renderer } from '@astrojs/markdoc/components';
-						import { collectHeadings, applyDefaultConfig, Markdoc, headingSlugger } from '@astrojs/markdoc/runtime';
+						import { collectHeadings, setupConfig, Markdoc } from '@astrojs/markdoc/runtime';
 import * as entry from ${JSON.stringify(viteId + "?astroContentCollectionEntry")};
 ${markdocConfigResult ? `import _userConfig from ${JSON.stringify(
               markdocConfigResult.fileUrl.pathname
@@ -88,16 +88,14 @@ export function getHeadings() {
             TODO: propose new `render()` API to allow Markdoc variable passing to `render()` itself,
             instead of the Content component. Would remove double-transform and unlock variable resolution in heading slugs. */
             ""}
-	headingSlugger.reset();
 	const headingConfig = userConfig.nodes?.heading;
-	const config = applyDefaultConfig(headingConfig ? { nodes: { heading: headingConfig } } : {}, entry);
+	const config = setupConfig(headingConfig ? { nodes: { heading: headingConfig } } : {}, entry);
 	const ast = Markdoc.Ast.fromJSON(stringifiedAst);
 	const content = Markdoc.transform(ast, config);
 	return collectHeadings(Array.isArray(content) ? content : content.children);
 }
 export async function Content (props) {
-	headingSlugger.reset();
-	const config = applyDefaultConfig({
+	const config = setupConfig({
 		...userConfig,
 		variables: { ...userConfig.variables, ...props },
 	}, entry);

package/dist/nodes/heading.d.ts

@@ -1,4 +1,10 @@
-import { type Schema } from '@markdoc/markdoc';
+import { type ConfigType, type Schema } from '@markdoc/markdoc';
 import Slugger from 'github-slugger';
-export declare const headingSlugger: Slugger;
+type ConfigTypeWithCtx = ConfigType & {
+    ctx: {
+        headingSlugger: Slugger;
+    };
+};
 export declare const heading: Schema;
+export declare function setupHeadingConfig(): ConfigTypeWithCtx;
+export {};

package/dist/nodes/heading.js

@@ -1,8 +1,7 @@
 import Markdoc from "@markdoc/markdoc";
 import Slugger from "github-slugger";
 import { getTextContent } from "../runtime.js";
-const headingSlugger = new Slugger();
-function getSlug(attributes, children) {
+function getSlug(attributes, children, headingSlugger) {
   if (attributes.id && typeof attributes.id === "string") {
     return attributes.id;
   }
@@ -22,7 +21,7 @@ const heading = {
     var _a, _b;
     const { level, ...attributes } = node.transformAttributes(config);
     const children = node.transformChildren(config);
-    const slug = getSlug(attributes, children);
+    const slug = getSlug(attributes, children, config.ctx.headingSlugger);
     const render = ((_b = (_a = config.nodes) == null ? void 0 : _a.heading) == null ? void 0 : _b.render) ?? `h${level}`;
     const tagProps = (
       // For components, pass down `level` as a prop,
@@ -33,7 +32,18 @@ const heading = {
     return new Markdoc.Tag(render, tagProps, children);
   }
 };
+function setupHeadingConfig() {
+  const headingSlugger = new Slugger();
+  return {
+    ctx: {
+      headingSlugger
+    },
+    nodes: {
+      heading
+    }
+  };
+}
 export {
   heading,
-  headingSlugger
+  setupHeadingConfig
 };

package/dist/nodes/index.d.ts

@@ -1,4 +1,4 @@
-export { headingSlugger } from './heading.js';
+export { setupHeadingConfig } from './heading.js';
 export declare const nodes: {
     heading: import("@markdoc/markdoc").Schema;
 };

package/dist/nodes/index.js

@@ -1,7 +1,7 @@
 import { heading } from "./heading.js";
-import { headingSlugger } from "./heading.js";
+import { setupHeadingConfig } from "./heading.js";
 const nodes = { heading };
 export {
-  headingSlugger,
-  nodes
+  nodes,
+  setupHeadingConfig
 };

package/dist/runtime.d.ts

@@ -1,10 +1,13 @@
 import type { MarkdownHeading } from '@astrojs/markdown-remark';
 import { type ConfigType as MarkdocConfig, type RenderableTreeNode } from '@markdoc/markdoc';
 import type { ContentEntryModule } from 'astro';
-/** Used to reset Slugger cache on each build at runtime */
+/** Used to call `Markdoc.transform()` and `Markdoc.Ast` in runtime modules */
 export { default as Markdoc } from '@markdoc/markdoc';
-export { headingSlugger } from './nodes/index.js';
-export declare function applyDefaultConfig(config: MarkdocConfig, entry: ContentEntryModule): MarkdocConfig;
+/**
+ * Merge user config with default config and set up context (ex. heading ID slugger)
+ * Called on each file's individual transform
+ */
+export declare function setupConfig(userConfig: MarkdocConfig, entry: ContentEntryModule): MarkdocConfig;
 /**
  * Get text content as a string from a Markdoc transform AST
  */

package/dist/runtime.js

@@ -1,19 +1,34 @@
 import Markdoc from "@markdoc/markdoc";
-import { nodes as astroNodes } from "./nodes/index.js";
+import { setupHeadingConfig } from "./nodes/index.js";
 import { default as default2 } from "@markdoc/markdoc";
-import { headingSlugger } from "./nodes/index.js";
-function applyDefaultConfig(config, entry) {
+function setupConfig(userConfig, entry) {
+  const defaultConfig = {
+    // `setupXConfig()` could become a "plugin" convention as well?
+    ...setupHeadingConfig(),
+    variables: { entry }
+  };
+  return mergeConfig(defaultConfig, userConfig);
+}
+function mergeConfig(configA, configB) {
   return {
-    ...config,
-    variables: {
-      entry,
-      ...config.variables
+    ...configA,
+    ...configB,
+    tags: {
+      ...configA.tags,
+      ...configB.tags
     },
     nodes: {
-      ...astroNodes,
-      ...config.nodes
+      ...configA.nodes,
+      ...configB.nodes
+    },
+    functions: {
+      ...configA.functions,
+      ...configB.functions
+    },
+    variables: {
+      ...configA.variables,
+      ...configB.variables
     }
-    // TODO: Syntax highlighting
   };
 }
 function getTextContent(childNodes) {
@@ -56,8 +71,7 @@ function collectHeadings(children) {
 }
 export {
   default2 as Markdoc,
-  applyDefaultConfig,
   collectHeadings,
   getTextContent,
-  headingSlugger
+  setupConfig
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@astrojs/markdoc",
   "description": "Add support for Markdoc pages in your Astro site",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "type": "module",
   "types": "./dist/index.d.ts",
   "author": "withastro",
@@ -40,7 +40,7 @@
     "zod": "^3.17.3"
   },
   "peerDependencies": {
-    "astro": "^2.5.0"
+    "astro": "^2.5.1"
   },
   "devDependencies": {
     "@astrojs/markdown-remark": "^2.2.1",
@@ -53,7 +53,7 @@
     "mocha": "^9.2.2",
     "rollup": "^3.20.1",
     "vite": "^4.3.1",
-    "astro": "2.5.0",
+    "astro": "2.5.1",
     "astro-scripts": "0.0.14"
   },
   "engines": {