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."。本文只整理仓库能直接核验的内容,不把星标、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 如果仓库没有提供命令,本文不会替它编造安装步骤,而是建议先打开 README 的"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。