GGitHubHelpers: keep emoji images across renders (#2381)

5c6b73ed创建于 4 天前历史提交

文件	最后提交记录	最后更新时间
app	Docs: set the viewport and keep pipeline animations at one height (#2289)	8 天前
content	Helpers: keep emoji images across renders (#2381)	4 天前
public	Docs: move pages to noun slugs and redirect the old URLs (#2282)	8 天前
src	Docs: redesign the homepage around a hammer striking one component apart (#1950)	18 天前
tests	Docs: drop the paged browser preview and repeated helpers (#1678)	1 个月前
.gitignore	Docs: migrate to waku	5 个月前
README.md	Docs: present takumi as one engine with several outputs (#2077)	12 天前
components.json	Docs: refactor playground	1 年前
package.json	Docs: move pages to noun slugs and redirect the old URLs (#2282)	8 天前
press.config.tsx	Docs: set the viewport and keep pipeline animations at one height (#2289)	8 天前
redirects.ts	Docs: move pages to noun slugs and redirect the old URLs (#2282)	8 天前
source.config.ts	Deps: refresh npm packages and move docs to TypeScript 7 (#1560)	1 个月前
tsconfig.json	Docs: build the template registry with the shadcn CLI (#1282)	2 个月前
waku.config.ts	Docs: redesign the homepage around a hammer striking one component apart (#1950)	18 天前

Takumi documentation website

This workspace contains the guides, homepage, playground, and template registry for takumi.kane.tw. It uses Fumapress, Fumadocs MDX, and Waku.

Run locally

Install workspace dependencies from the repository root:

bun install

The playground uses built workspace packages. Follow the contribution guide if those packages are missing or their source has changed.

Start the docs server:

cd docs
bun dev

Open https://takumi.localhost. The dev script uses portless. Check portless list and reuse an existing server when one is already running.

Find the source

Content	Location
Guides and API reference	`content/docs/*.mdx`
PDF guides	`content/docs/pdf/`
Navigation order	`content/docs/**/meta.json`
Homepage, playground, and showcase routes	`src/pages/`
Homepage sections	`app/components/home/`
Showcase projects and templates	`app/data/showcase.ts`
Installable image templates	`app/registry/image/`
Playground templates	`app/playground/templates/`
Site configuration and MDX components	`press.config.tsx`

Give each guide a distinct title and description in its frontmatter. These appear in navigation, page metadata, and generated Open Graph images. Keep existing URLs and heading anchors when editing prose so incoming links continue to work.

Validate edits

Run these commands from docs:

bun run typecheck
bun test app/playground tests --silent
bun run build

Run bun lint from the repository root. The production build checks documentation links and renders page Open Graph images. It needs network access to download the configured Google Fonts.

Follow the writing guidelines when adding or revising content.