templ.js

This guide now covers the full example pack currently shipped for release readiness work.

Included Examples

• markdown-report/
• html-email/
• json-api/
• config-files/
• documentation/

Files in the Examples

markdown-report/

• template.md.templ
• data.json
• README.md

html-email/

• template.html.templ
• data.json
• README.md

json-api/

• template.json.templ
• data.json
• README.md

config-files/

• .env.tmpl
• docker-compose.tmpl
• data.json
• README.md

documentation/

• template.md.templ
• data.json
• README.md

Implementation Links

• CLI command registration for templjs render: src/packages/cli/src/cli.ts
• CLI render implementation (renderCommand): src/packages/cli/src/commands/render.ts
• Core rendering API (renderTemplate): src/packages/core/src/index.ts
• Core renderer internals (Renderer): src/packages/core/src/renderer/renderer.ts

ADRs

• ADR 002: Parser Selection
• ADR 006: Testing Strategy
• ADR 007: Syntax Extensibility

Run an Example

pnpm --filter @templjs/core build
pnpm --filter @templjs/cli build
node src/packages/cli/dist/cli.js render \
  -t examples/markdown-report/template.md.templ \
  -i examples/markdown-report/data.json

Related source:

• src/packages/cli/src/commands/render.ts

Why These Examples

This pack covers the most representative release-readiness cases:

• Human-readable report generation (Markdown)
• Transactional messaging (HTML)
• Structured response transformation (JSON)
• Deployment-oriented config generation (.env and Docker Compose)
• API-style documentation generation (Markdown)

WI-021 now includes a generated in-repo demo video artifact for review.

Demo Video

• templjs-demo.mp4
• wi-021-demo-script.md

This site is open source. Improve this page.