Quickstart

Install TemplateDX and render a .mdx template against a props object. The snippets below use the Node API (load + transform + stringify). If your runtime can’t read templates from disk (browser, edge), precompile them to JSON ASTs at build time; see the last section.

Install

npm
yarn
pnpm

npm install @agentmark-ai/templatedx

yarn add @agentmark-ai/templatedx

pnpm add @agentmark-ai/templatedx

Render a template (Node)

Given my-template.mdx:

my-template.mdx

Hi {props.name}, welcome to TemplateDX.

Run it:

import { load, transform, stringify } from "@agentmark-ai/templatedx";

const ast = await load("./my-template.mdx");
const rendered = await transform(ast, { name: "Jim" });
console.log(stringify(rendered));

Output:

Hi Jim, welcome to TemplateDX.

load(path): parses the .mdx file from disk into an AST.
transform(ast, props): evaluates expressions and tag plugins against props.
stringify(ast): serializes the rendered AST back to a Markdown/text string.

Render a precompiled template (browser / edge)

transform() consumes a TemplateDX AST, not a compiled MDX component. Standard MDX loaders (@mdx-js/loader, @next/mdx, Vite MDX plugins) compile .mdx into a component function, which transform() can’t use. To render templates where you can’t read from disk, precompile them to JSON in a build step:

precompile.ts

import { load, compressAst } from "@agentmark-ai/templatedx";
import fs from "node:fs";

const ast = await load("./my-template.mdx");
compressAst(ast); // strips positions and other parse-only metadata in place
fs.writeFileSync("./my-template.json", JSON.stringify(ast));

At runtime, import the JSON and skip load:

render.ts

import { transform, stringify } from "@agentmark-ai/templatedx";
import ast from "./my-template.json";

const rendered = await transform(ast, { name: "Jim" });
console.log(stringify(rendered));
// Hi Jim, welcome to TemplateDX.

load bundles imported components into the AST, so precompiled templates keep working when they import other .mdx files.

Next steps

Syntax

Tags, expressions, components, and XML passthrough

Variables

Props and scope resolution

Custom tags

Write your own <Tag> plugins

Custom filters

Extend expression evaluation with filters

Get started

Coding agents

Concepts

Build prompts

Evaluate

Observe

Deploy

Account & billing

Integrations

Reference

Install

Render a template (Node)

Render a precompiled template (browser / edge)

Next steps

Syntax

Variables

Custom tags

Custom filters

​Install

​Render a template (Node)

​Render a precompiled template (browser / edge)

​Next steps

Syntax

Variables

Custom tags

Custom filters

Install

Render a template (Node)

Render a precompiled template (browser / edge)

Next steps