google-labs-code/design.md · 中文介绍

google-labs-code/design.md

★ 28,973 · Forks 2,322

DESIGN.md 是一套面向编程助手的视觉设计文件规范,附带命令行工具。它把设计规则集中在一份可反复读取的文件里,让助手在生成或修改界面时有一致的依据,适合希望在多次开发任务中沿用同一套视觉风格的团队。

一份文件怎么描述设计

YAML 设计令牌记录颜色、字体、圆角等精确值,Markdown 正文说明这些值为什么这样选、该用在什么地方。例如,可以在令牌中定义品牌色,再用正文约定它用于主要操作按钮。助手既能读取具体色值,也能知道何时使用它。

校验、对比与导出

命令行工具可以校验文件结构、查找失效的令牌引用、检查 WCAG 对比度,并以结构化 JSON 返回结果。修改设计系统后,可以对比两个版本,检查令牌和说明文字是否出现回退。如果项目使用 Tailwind v3,还可以把令牌导出为用于 theme.extend 的 JSON。

从哪里开始

可以先看 README 的格式示例,了解 YAML 和 Markdown 如何配合。需要核对字段和语法时,再查阅完整规范 docs/spec.md。手头已有 DESIGN.md 文件的话,可以用 npm 包 @google/design.md 提供的 lint 命令检查。

Kai 的头像

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注