clawpage-web
v1.0.1
Published
Astro-based static site generator for [clawpage](https://github.com/imyelo/clawpage). Renders chat YAML files into shareable pages and deploys to GitHub Pages.
Readme
clawpage-web
Astro-based static site generator for clawpage. Renders chat YAML files into shareable pages and deploys to GitHub Pages.
Usage
npx clawpage-web dev # local dev server
npx clawpage-web build # build static site
npx clawpage-web preview # preview built site locallyConfiguration
Place a clawpage.toml in your project root:
site = "https://your-username.github.io"
base = "/your-repo-name"
[template.options]
title = "My Chats"
subtitle = "// conversation archive"
footer = "powered by [@you](https://github.com/you)"
[template.options.promo]
enabled = true| Key | Type | Description |
|-----|------|-------------|
| site | string (URL) | Full URL of your deployed site |
| base | string | Base path for GitHub Pages project sites |
| public_dir | string | Static assets directory (relative to config file) |
| out_dir | string | Build output directory (relative to config file) |
| chats_dir | string | Custom chats directory path (absolute or relative to config file) |
| template.options.title | string | Homepage title |
| template.options.subtitle | string | Homepage subtitle |
| template.options.description | string | Meta description for the site |
| template.options.footer | string | Footer text (Markdown supported) |
| template.options.analytics.google_analytics_id | string | Google Analytics 4 Measurement ID | "G-XXXXXXXXXX" |
| template.options.promo.enabled | boolean | Show a promotional block on the homepage to help spread clawpage |
Chat Files
Chat YAML files go in chats/ (or the path set by chats_dir). They are generated by the clawpage CLI.
- Only chats with
visibility: publicappear on the homepage index. - All chats (including
private) are accessible via their direct URL/chats/{slug}.
See Clawpage's docs/clawpage-data-format.md for the full YAML schema.
