google-labs-code/design.md:README 來源編輯指南
根據 README、倉庫資料與授權整理 google-labs-code/design.md 的安裝與核驗路徑。
專案定位
google-labs-code/design.md 的 README 將專案描述為「A format specification for describing a visual identity to coding agents. DESIGN.md gives agents a persistent, structured understanding of a design system.」。本文只整理倉庫可直接核對的內容,不把 star、Fork 或宣傳語當成品質證明。README 在「DESIGN.md」下寫到:A format specification for describing a visual identity to coding agents. DESIGN.md gives agents a persistent, structured understanding of a design system.。這說明的是專案邊界,不是已完成的生產驗證。
適用場景
從 README 的「Design Token Interoperability」與相關條目,可以先判斷它是否處理你的實際問題:Tailwind v4 theme (CSS) , npx @google/design.md export --format css-tailwind DESIGN.md , emits a CSS @theme { ... } block using Tailwind v4's CSS-variable token namespaces (--color-, --font-, --text-, --leading-, --tracking-,。若需求不同,不應只因專案熱度就採用。本文保留原始專案名、命令與元件名,方便回到一手來源核對。 README 另外列出一項可核對的資訊:Tailwind v3 config (JSON) , npx @google/design.md export --format json-tailwind DESIGN.md , emits a theme.extend JSON object for tailwind.config.js. --format tailwind is a backwards-compatible alias.。這類原文條目可用來設計試跑步驟,但不能取代實際環境測試。
運作方式
README 將運作方式分散在「The Format」等段落。可確認的線索包括:An agent that reads this file will produce a UI with deep ink headlines in Public Sans, a warm limestone background, and Boston Clay call-to-action buttons.。本文不把未寫出的架構、效能或安全邊界補成結論;真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。
安裝與第一次執行
第一次安裝應從 README 指出的入口開始。目前可核對的命令是: npm install @google/design.md 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「The Format」,確認系統依賴、預設埠與首次初始化。
設定與日常使用
日常使用取決於專案文件。README 的「The Specification」段落提到:The full DESIGN.md spec lives at docs/spec.md. What follows is a condensed reference.。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄;沒有寫出的預設值,應在測試環境驗證並保留回滾副本。 同一部分也提到:DTCG tokens.json (W3C Design Tokens Format Module , npx @google/design.md export --format dtcg DESIGN.md。