htmx Documentation Website

The htmx documentation site, built with Astro and Tailwind CSS.

Development

From the repo root:

npm run site    # or: npm run www

Or from this directory:

bun install
bun run dev

The dev server starts at http://localhost:4321. The predev script syncs ../dist/ into public/js/ automatically.

Building

bun run build
bun run preview   # preview the production build

Testing

End-to-end tests use Playwright:

bun run test          # headless
bun run test:headed   # with browser window
bun run test:ui       # interactive UI mode

Structure

src/
  content/        # Markdown content (docs, reference, patterns)
  components/     # Astro components
  layouts/        # Page layouts
  pages/          # Route pages
  lib/            # Utilities and helpers
  assets/         # Images and static assets
public/
  js/             # htmx build artifacts (synced from ../dist/)