andocs

Installation
SKILL.md

Andocs authoring

For an Andocs introduction or a local demo, follow the introduction flow. Start a local preview with the published CLI command in that guide.

For other editing tasks, find the documentation root from the request or repository before editing. If multiple roots remain plausible, ask which one to use. Follow the repository's language and preview rules.

Read the reference that matches the work:

  • Markdown rendering — read when writing diagrams, math, interactive html-preview blocks, or Andocs-specific links.
  • Prototypes — read when creating or editing prototype.json, HTML pages, navigation between pages, relative static files, shared assets, or prototype blocks.
  • Review status and releases — read when a prototype uses screen review badges, releases.json, or <id>@<release>.html screen variants.
  • Prototype state — read when prototype data must survive refresh or an existing stateful prototype needs migration.
  • Web Components — read when a prototype uses Custom Elements or Shadow DOM.
  • OpenDesign handoff — read when the user asks to edit an Andocs prototype in OpenDesign or asks to prepare OpenDesign from source.

For a requested local preview, identify the documentation root and check that Bun is available. Use bunx andocs@latest serve --path <docs-root> only when starting a server is authorized by the user and the repository instructions. The CLI help is bunx andocs@latest -h.

Before finishing, check that referenced files exist, fenced blocks use the right language, and any prototype state handles unavailable storage. The public Andocs demo shows a complete prototype repository.

Installs
40
GitHub Stars
3
First Seen
Feb 25, 2026