Skip to content

byronwang2005/Kami

 
 

Repository files navigation

Kami

Good content deserves good paper.

Stars Version License Twitter

Why

Kami (紙, かみ) means paper in Japanese: the surface where a finished idea lands. AI-generated documents keep drifting into generic gray, inconsistent styling, and layouts that change every session.

Kami is a document design system for the AI era: one constraint language, six formats, simple enough for agents to run reliably, strict enough to keep every output coherent and ready to ship. English and Chinese are first-class; Japanese works via a best-effort CJK path with visual QA before delivery.

Part of a trilogy: Kaku (書く) writes code, Waza (技) drills habits, Kami (紙) delivers documents.

See it

Tesla company one-pager
One-Pager · 中文
Tesla 公司介绍 · 单页
Agent keynote slides
Slides · English
Agent keynote, 6 slides
Elon Musk resume
Resume · English
Founder CV, 2 pages
Kaku portfolio
Portfolio · 日本語
Kaku ターミナル作品集 · 7 ページ

Usage

Claude Code

npx skills add tw93/kami -a claude-code -g -y

Codex

npx skills add tw93/kami -a codex -g -y

Generic agents (opencode, pi, and other tools that read from ~/.agents/; codex is included, but use -a codex if you only target Codex)

npx skills add tw93/kami -a '*' -g -y

Claude Desktop

Download kami.zip, open Customize > Skills > "+" > Create skill, and upload the ZIP directly (no need to unzip).

The ZIP is lightweight: Chinese fonts load from local checkout first, then jsDelivr CDN. If rendering is off, Claude downloads them on the next run. To update: download the same URL, click "..." on the skill card, choose Replace, upload.

The skill auto-triggers from natural requests, no slash command needed. Optimized for English and Chinese; Japanese supported via a best-effort CJK path with visual QA before delivery.

Example prompts by language:

  • English: make a one-pager for my startup / turn this research into a long doc / write a formal letter / make a portfolio of my projects / build me a resume / design a slide deck for my talk
  • 中文: 帮我做一份一页纸 / 帮我排版一份长文档 / 帮我写一封正式信件 / 帮我做一份作品集 / 帮我做一份简历 / 帮我做一套演讲幻灯片
  • 日本語: スタートアップ向けの一枚資料を作って / この調査を長文レポートに整えて / 正式な依頼文を作って / プロジェクト作品集を作って / 履歴書を作って / 登壇用スライドを作って

Design

Warm parchment canvas, ink blue as the sole accent, serif carries hierarchy, no hard shadows or flashy palettes. Not a UI framework; a constraint system for printed matter. Documents should read as composed pages, not dashboards.

Six document types (One-Pager, Long Doc, Letter, Portfolio, Resume, Slides) with dedicated EN/CN templates and a best-effort Japanese path. Twelve inline SVG diagram types included. Kami picks the right variant based on the language you write in.

Element Rule
Canvas #f5f4ed parchment, never pure white
Accent Ink blue #1B365D only, no second chromatic hue
Neutrals All warm-toned (yellow-brown undertone), no cool blue-grays
Serif Body 400, headings 500. Avoid synthetic bold
Line-height Tight titles 1.1-1.3, dense body 1.4-1.45, reading body 1.5-1.55
Shadows Ring or whisper only, no hard drop shadows
Tags Solid hex backgrounds only. rgba() triggers a WeasyPrint double-rectangle bug

Fonts: Each language uses a single serif font for the entire page. Chinese: TsangerJinKai02. Japanese: YuMincho. English: Charter. TsangerJinKai is free for personal use, commercial use requires a license from tsanger.cn. All other fonts are system-bundled.

Full spec: design.md. Cheatsheet: CHEATSHEET.md.

Background

I like investing in US equities and ask Claude to write research reports all the time. Every output landed in the same default-doc look: gray, flat, a different layout each session. The structure was hard to scan, the formatting felt dated, and nothing about the page made me want to keep reading. So I started fixing the typography, the palette, the spacing, one rule at a time, until the report became a page I actually enjoyed.

Later I needed to present "The Agent You Don't Know: Principles, Architecture and Engineering Practice." I already had the document and didn't want to build slides from scratch, so I used Claude Design to lay it out in my own style, tweaked it round after round, and eventually got it to a place I was happy with. That process added inline SVG charts, a unified warm palette, and a tighter editorial rhythm. It kept growing until it covered every document I regularly ship, so I kept abstracting the process, and it became kami: one quiet design system I can hand to any agent and trust the output.

Support

  • If kami helped you, share it with friends or give it a star.
  • Got ideas or bugs? Open an issue or PR.
  • I have two cats, TangYuan and Coke. If you think kami delights your life, you can feed them canned food.

License

MIT License. Feel free to use kami and contribute.

About

👩‍🚒 Good content deserves good paper.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • HTML 83.8%
  • Python 11.8%
  • CSS 4.3%
  • Shell 0.1%