Deckicorn

Spec-driven presentation runtime: compile Markdown decks + layout YAML into a canonical presentation spec, then render with a 2D (Arcade) runtime.

Documentation

• Public site: deckicorn.org (Docusaurus + Sphinx API reference)
• ADR overview: docs/README-deckicorn-adr.md
• Presentation spec: docs/SPEC-presentation-spec.md
• Deckicorn MD dialect: docs/SPEC-deckicorn-md-dialect.md
• Deck project manifest: docs/SPEC-deckicorn-project-manifest.md
• Implementation plan: plan/deckicorn-implementation-plan.md
• AI workflow rules: tools/ai-rules/

Git workflow

Day-to-day work happens on develop; master is ff-merged when Development CI is green (A2C development-workflow.md).

git checkout develop

Quick start

pip install -e ".[dev]"
pre-commit install
pre-commit install --hook-type commit-msg

From a deck project directory (see examples/deckicorn-hello/deckicorn.yaml):

cd examples/deckicorn-hello
deckicorn build
deckicorn preview          # requires pip install -e ".[runtime]"
deckicorn preview --show-bounds
deckicorn package --clean  # requires pip install -e ".[runtime,packaging]"

Ad hoc paths (without deckicorn.yaml):

deckicorn build examples/deckicorn-hello/deck.md \
  --layout examples/deckicorn-hello/layout-default.yaml \
  --out examples/deckicorn-hello/build/deck-spec.yaml
deckicorn run examples/deckicorn-hello/build/deck-spec.yaml

Changelog and pre-commit

This repository follows A2C changelog policy (tools/ai-rules/rules/11-changelog-policy.md):

• Maintain CHANGELOG.md in Keep a Changelog format.
• Curate ## [Unreleased] as release-relevant work lands.
• Stage CHANGELOG.md with any commit that changes other files (check-changelog hook).

Version source: root VERSION (kept in sync with pyproject.toml and deckicorn_spec.__version__ at release time).

Release workflow: docs/release-pipeline.md.

Project layout