@avodado/cli 0.0.1

package/templates/.cursor/rules/avodado.mdc

@@ -0,0 +1,27 @@
+<!-- Repo location: .cursor/rules/avodado.mdc -->
+---
+description: Authoring Avodado documentation (Markdown + typed blocks)
+globs:
+  - "docs/**/*.md"
+alwaysApply: false
+---
+
+# Avodado docs
+
+This repo uses **Avodado**: documentation is Markdown with typed, fenced YAML blocks,
+and the `.md` files are the single source of truth. When writing or editing anything
+under `docs/`, follow the full authoring skill at **`.avodado/skill/SKILL.md`**.
+
+Essentials:
+
+- Prose is plain Markdown. Structure goes in typed blocks — use only these nine:
+  `sequence`, `erd`, `table`, `callout`, `userstory`, `timeline`, `kanban`, `tracker`,
+  `meta`. Block bodies are YAML.
+- Never paste raw HTML or inline SVG into a doc; express it as a block.
+- Use only documented fields for each block; don't invent block types or fields.
+- Add `id:` to a block that needs referencing; reference it as `doc#id` (or `#id` in
+  the same file). Don't reference an id that doesn't exist.
+- Edit the specific block surgically rather than rewriting the whole document.
+- After any change, run `avo check` and fix every diagnostic before finishing.
+
+See `.avodado/skill/SKILL.md` for each block's exact fields and worked examples.

package/templates/CLAUDE.md

@@ -0,0 +1,22 @@
+<!-- Repo location: CLAUDE.md at the repository root. Claude Code reads this automatically. -->
+
+# Avodado — agent guide
+
+This project uses **Avodado**: documentation-as-code where a doc is Markdown with
+typed, fenced YAML blocks, and the files on disk are the single source of truth.
+
+## Writing or editing documentation
+
+When creating or changing any document under `docs/**/*.md`, **follow the authoring
+skill at `.avodado/skill/SKILL.md`**. It defines the block grammar, every block's
+fields, and the `doc#id` reference scheme. In short:
+
+- Prose is plain Markdown; structure goes in typed blocks (e.g. `sequence`, `erd`,
+  `table`, `callout`, `c4`, `flow`, `timeline`, `userstory`). Never paste raw HTML
+  or inline SVG.
+- Use only the documented block types and their documented fields — the schemas are
+  strict, so an unknown block or field fails validation. Bodies are YAML.
+- Give a block an `id:` when it needs to be referenced; reference it as `doc#id`.
+- Edit the specific block surgically — don't regenerate whole files.
+- **Run `avo check` and fix all diagnostics before finishing.** A change isn't done
+  until it passes.

package/templates/avodado.config.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://avodado.dev/schema/config.json",
+  "docsDir": "docs",
+  "outDir": "dist"
+}

package/templates/docs/getting-started.md

@@ -0,0 +1,59 @@
+```meta
+title: Getting started
+subtitle: Your first Avodado document — replace this with whatever you need to capture.
+tag: GUIDE · v0.1
+```
+
+## What is this?
+
+This file is your first Avodado document. It is plain Markdown plus typed,
+fenced YAML blocks. Prose stays as prose; anything structured goes in a block.
+
+Open this file in your editor and edit it like normal. Run `avo check` after
+edits to validate the schemas and references.
+
+```callout
+tone: tip
+title: The one rule
+body: The .md file on disk is the source of truth. Edit a block surgically;
+  do not regenerate the whole document. Run avo check and fix every diagnostic
+  before finishing a change.
+```
+
+## A few example blocks
+
+```timeline
+items:
+  - label: P0 — Stand up the docs
+    date: today
+    status: current
+    desc: Run avo check and fix any diagnostics
+  - label: P1 — Add the first feature
+    date: this week
+    status: next
+    desc: One feature with a userstory block
+  - label: P2 — Wire CI
+    date: later
+    status: future
+    desc: Run avo check on every PR
+```
+
+```table
+columns: [Block, What it captures]
+rows:
+  - [meta, Document title and subtitle]
+  - [callout, Note / tip / warn / danger]
+  - [table, Tabular data]
+  - [sequence, Interaction over time (SVG diagram)]
+  - [erd, Entities and relations (SVG diagram)]
+  - [userstory, Agile story + acceptance criteria + links]
+  - [timeline, Phases or milestones]
+  - [kanban, Now / next / later board]
+  - [tracker, Task list with status + priority]
+```
+
+## What next
+
+- Edit this file and run `avo check`.
+- Run `avo render docs/getting-started.md -o out.html` and open the result.
+- Read `.avodado/skill/SKILL.md` for the full grammar.