# Chiltepin

> Markdown with typed blocks for diagrams, tables, and slide decks.
> Use the CLI to validate document structure and render the result.

Chiltepin is documentation-as-code. A doc is plain Markdown; every visual thing
is a typed block: a fenced section whose info-string is the block type and
whose body is YAML. The author supplies nodes, edges, and labels; the renderer computes layout,
with explicit placement available on supported blocks. `chiltepin check` reports
schema and reference errors. Review the technical facts separately.
MIT licensed. Reference CLI version: chiltepin 0.47.10.

## Install

- Give your agent the skill (supported coding agents):
  `npx skills add jdiejim/chiltepin -y`
- Then ask for a doc in plain words. The agent runs `npx -y chiltepin@latest block <type>`
  for a block's fields and `npx -y chiltepin@latest check` to validate.
- By hand: `npx chiltepin@latest demo` renders every block; `npx chiltepin@latest block <type>`
  prints one block's contract; `npx chiltepin@latest check docs/` validates;
  `npx chiltepin@latest html docs/x.md -p` renders one doc; `npx chiltepin@latest studio`
  opens the local visual editor. In a project: `pnpm add -D chiltepin`,
  then `pnpm exec chiltepin init` writes chiltepin.config.json and two starter docs.
- No shell in the tool (ChatGPT, Gemini, a custom GPT)? `npx chiltepin@latest skill` prints
  the skill as a system prompt to paste.

## Block families

- Narrative & prose (11): meta, callout, prose, glossary, pullquote, layers, figure, faq, divider, bignumber, takeaways
- Tables & code (5): table, stats, code, slo, benchmark
- API (3): endpoint, packet, eventcontract
- Architecture (9): c4, uml, frontend, cluster, block, felogic, archmap, usecase, pkg
- Flows & state (11): sequence, flow, state, dfd, swimlane, steps, cycle, gitgraph, saga, spans, timing
- Data model (1): erd
- Charts & overviews (14): tree, pyramid, journey, gantt, graph, quadrant, chart, heatmap, sankey, treemap, venn, fishbone, slopegraph, mindmap
- Planning & backlogs (17): userstory, timeline, kanban, proscons, cvt, agenda, list, stories, pattern, gallery, changelog, risk, statustable, storymap, rollout, chevrons, roadmap
- Business & decisions (16): matrix, anatomy, composition, drivers, options, spec, envelope, swot, okr, persona, team, scorecard, wardley, harvey, scqa, scenarios
- Design system (5): wireframe, palette, typescale, dodont, inventory
- Algorithms (4): array, linkedlist, bintree, hashmap
- AI & agents (6): agentloop, trace, prompt, context, neuralnet, modelcard
- Quality & audits (5): audit, checklist, perfbudget, percentiles, threatmodel

Every field, enum, and terse one-line form: `npx chiltepin@latest block <type>`.

## Links

- Docs: https://chiltepin.dev/docs
- Block catalog, every block rendered live: https://chiltepin.dev/blocks
- Document templates: https://chiltepin.dev/templates
- The whole authoring skill as one file: https://chiltepin.dev/llms-full.txt
- Source: https://github.com/jdiejim/chiltepin
- npm: https://www.npmjs.com/package/chiltepin