examples.md

April 22, 2026 · View on GitHub

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

Included Examples

Files in the Examples

markdown-report/

html-email/

json-api/

config-files/

documentation/

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

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.tmpl \
  -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