goodoc

A documentation framework for project homepages, docs, and blogs

English · 简体中文

goodoc turns Markdown into a project site — a landing page, docs, and a blog — that builds to a static site for GitHub Pages. Every doc and post renders in two views: humanize (for people) and agent (clean HTML for machines). It's multilingual (locale-prefixed URLs, English default).

Quick start

git clone https://github.com/zobinHuang/goodoc.git my-project
cd my-project
npm install
npm run dev        # http://localhost:3000

1. Edit lib/site-config.ts — project name, navigation, and landing copy (palette in app/theme.css).
2. Add Markdown to content/<locale>/docs/ and content/<locale>/blog/ (default locale is en).
3. Push to GitHub; the bundled Actions workflow publishes to Pages (Settings → Pages → Source → GitHub Actions).

Agent skill

This repo ships an agent skill at skills/goodoc/ that teaches a coding agent (Claude, Codex, Gemini, …) how to author content, configure, build, and deploy on this template. Install and manage it with the skills CLI:

npx skills        # install / manage the bundled skill for your agent(s)

Build & deploy

npm run build                                 # static export → out/
NEXT_PUBLIC_BASE_PATH=/goodoc npm run build   # GitHub project site (sub-path)

Upgrade

Cloned goodoc as a template? Pull upstream framework updates without touching your content:

npm run upgrade

See UPGRADING.md and CHANGELOG.md.

Docs

• On-site: visit / (redirects to /en/) or /en/docs/.
• Framework internals: dev-docs/.

Tech: Next.js 16 (App Router) · React 19 · TypeScript · Tailwind CSS v4 · static export.

License

See LICENSE.