Public documentation for GitPaywall: connect a GitHub repo and turn it into a working product. Live at https://gitpaywall.com/docs/.
Written for people and for agents:
- Real page routes under
/docs/, GSAP page transitions, the same look as gitpaywall.com. - A Markdown copy of every page (
<page>/index.md), plus/docs/llms.txtand/docs/llms-full.txt. - This repo is a Claude Code and Codex plugin marketplace. The
gitpaywallplugin adds a GitPaywall skill (the hosted tools' MCP connection comes in 0.2.0):
/plugin marketplace add Organized-AI/gitpaywall-docs
/plugin install gitpaywall@gitpaywall
| Path | What it is |
|---|---|
content/*.md |
The pages. Edit these. |
scripts/site.mjs |
Navigation order, old-anchor map, white-label word list, GA4 ID |
scripts/build.mjs |
Builds public/docs/ (HTML, Markdown copies, llms.txt, llms-full.txt, sitemap, 404). No dependencies. |
scripts/check.mjs |
Links, anchors, ASCII Markdown, white-label rule, secrets, plugin manifests |
public/docs/assets/ |
CSS, JS (transitions, copy buttons, GA4 events), logo, GitHub mark |
public/_redirects, public/_headers |
Old Rails URLs, headers |
plugin/ |
The gitpaywall plugin: skill, Claude Code and Codex manifests |
DOCUMENTATION/claude-templates/ |
Agent templates and the plugin MCP config, to install on the first local Claude Code run |
.claude-plugin/, .agents/plugins/ |
Marketplace files for Claude Code and Codex |
PLANNING/PHASES.md |
The phased plan |
node scripts/build.mjs && node scripts/check.mjs # local
npx wrangler@4 deploy # runs both, then deploysThe Worker serves only gitpaywall.com/docs*; every other path on gitpaywall.com is the Rails app. The Field Guide at /guide is a separate Worker.
Pages load the same GA4 property as gitpaywall.com and send docs_view, docs_copy (code copy buttons) and signup_start (the Start free button).