免费工具,无需注册
DESIGN.md 校验器
粘贴或上传 DESIGN.md,按照DESIGN.md 格式进行检查:frontmatter、颜色、令牌引用、章节顺序和文字对比度,并实时预览其中的令牌。校验在你的浏览器中运行,文件不会被上传。需要一个起点?浏览从真实网站提取的DESIGN.md 示例。
常见问题
DESIGN.md 校验器常见问题
关于免费工具“DESIGN.md 校验器”的简短解答。
YAML frontmatter、必需的 primary 颜色、颜色是否使用颜色格式书写(hex、rgb、hsl、oklch、颜色名称等)、以 px、em 或 rem 为单位的字号和圆角、字体排版属性、组件属性及其令牌引用(包括未加引号、因而 YAML 不会当作文本读取的引用)、omitted 列表、重复或顺序错误的章节,以及每个组件的文字颜色与背景颜色之间的对比度是否达到 WCAG AA 的最低要求 4.5:1。错误会使文件无效;警告则标出值得修复的问题。
不会。校验完全在你的浏览器中运行:你粘贴的文本或选择的文件绝不会发送到我们的服务器。预览发出的唯一请求是获取字体样式表:由我们的服务器从 Google Fonts 获取,请求中只包含你的字体排版令牌里的字体族名称。
Google 的 DESIGN.md 格式,即 Stitch 使用、并发布在 google-labs-code/design.md 仓库中的格式。校验器采用的规则与 Design Extractor 检查它生成的每份 DESIGN.md 时相同,另外还会检查组件颜色的对比度。
像 "{colors.brand}" 这样的引用,必须指向 frontmatter 中存在的令牌,这里是 colors 下的 brand 条目。添加缺失的令牌,或让引用指向一个已存在的令牌。引用要保留引号:YAML 会把不带引号的 {colors.brand} 当作映射,而不是文本。
可以。Google 的开源命令行工具可以在你的流水线中检查文件:运行 npx @google/design.md lint DESIGN.md。它会输出一份 JSON 报告,发现错误时以退出码 1 退出,这样文件有问题时任务就会失败。它的规则与本页面有重叠,但部分严重级别不同。