Skip to content

livetemplate/docs

Repository files navigation

livetemplate/docs

Source for the LiveTemplate documentation website, built with tinkerdown.

Production site: https://livetemplate.fly.dev (Phase 6 onwards)

How content gets here

Most pages are mirrored from canonical files in the source repos:

Section Source repo Sync mechanism
Reference, Guides livetemplate/livetemplate GitHub Action on release tag (Phase 3)
TypeScript client docs livetemplate/client GitHub Action on release tag
CLI docs livetemplate/lvt GitHub Action on release tag
Examples / patterns metadata livetemplate/examples GitHub Action on release tag
Recipes (interactive) this repo Authored directly here

The source-of-truth matrix (Phase 2 deliverable) lives at content/_meta/source-of-truth.md.

Local development

# Build tinkerdown from source if you haven't already
go install github.com/livetemplate/tinkerdown/cmd/tinkerdown@latest

# Serve the site
tinkerdown serve content/

# Open http://localhost:8080

Use tinkerdown serve content/ --watch for hot reload while editing.

Validating content

tinkerdown validate content/

CI runs validate on every PR.

Build & deploy

Phase 1 wires up the staging Dockerfile + fly.toml. Phase 6 promotes to production at livetemplate.fly.dev.

Plan

The full multi-phase build plan lives at /home/adnaan/.claude/plans/i-jaunty-boot.md (in Claude's plan store, not in this repo). Per-phase progress and learnings are tracked at /home/adnaan/.claude/plans/learnings/.

About

Docs site for the LiveTemplate framework, built with tinkerdown

Resources

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors