git clone https://github.com/dkdev24/pele-animatecd pele-animatepnpm installpnpm test # renders every Mermaid example in the docs and README with Pele, and checks icon namespnpm build # builds the site (a placeholder until the site lands)
The package is plain ESM at the repository root: no build step. The site lives in site/.
Docs are the Markdown files in docs/. A fenced block marked mermaid must render, and every @{ icon } name in it must exist.
Fence convention: ```mermaid live is a diagram GitHub can also draw; the site animates it. A diagram with @{ icon } nodes uses ```mermaid-icons live, because GitHub's Mermaid cannot draw icons (it shows "?" boxes), so GitHub shows the source text and the site animates it.
Tabler packs are generated: node scripts/build-tabler.mjs <path to a tabler-icons checkout> rewrites tabler/*.js. Do not edit those
files by hand. The Tabler version is recorded in each file header and in THIRD-PARTY-NOTICES.md.
Add an entry to CHANGELOG.md for any user-visible change. Breaking changes also get a section in docs/migrating.md.
Versioning stays on 0.x.
Keep example diagrams generic (clients, APIs, databases).