从0到1写出DESIGN.md:通过lint校验的第一份设计系统文件
从0到1写出DESIGN.md通过lint校验的第一份设计系统文件【免费下载链接】design.mdA format specification for describing a visual identity to coding agents. DESIGN.md gives agents a persistent, structured understanding of a design system.项目地址: https://gitcode.com/GitHub_Trending/de/design.mdDESIGN.md 是一个给 AI 编码代理coding agents描述视觉识别的文件格式它让设计系统Design System变成一份机器可读 人类可读的文档。本文将带你从 0 到 1 写出你的第一份 DESIGN.md 设计系统文件并用官方 CLI 的 lint 命令一次性通过校验。全程只需 3 个步骤不需要设计背景。一、DESIGN.md 设计系统文件是什么一句话概括DESIGN.md 设计令牌YAML front matter 设计理由Markdown 正文。层内容作用YAML front matter颜色、字体、圆角、间距、组件令牌给代理精确的数值Markdown 正文##章节 文字说明告诉代理为什么这样取值完整的格式规范见 docs/spec.md理念背景可看 PHILOSOPHY.md。二、准备工作安装校验工具写文件前先装好质检工具这样每写一步都能立刻验证npm install google/design.md Windows 用户若遇到命令无输出请改用designmd别名npx -p google/design.md designmd lint DESIGN.md三、第 1 步写 YAML 设计令牌在文件开头用---分隔符包裹 YAML最低限度只需要name、colors、typography三组--- name: My Brand colors: primary: #1A1C1E secondary: #6C7278 tertiary: #B8422E neutral: #F7F5F2 typography: h1: fontFamily: Public Sans fontSize: 3rem body-md: fontFamily: Public Sans fontSize: 1rem rounded: sm: 4px md: 8px spacing: sm: 8px md: 16px ---⚠️ 两个新手高频坑必须定义primary颜色否则会触发missing-primary警告颜色值写任意合法 CSS 颜色即可hex、rgb()、oklch()都支持四、第 2 步按顺序写 Markdown 正文正文用##标题组织章节可省略但顺序固定Overview别名 Brand StyleColorsTypographyLayoutElevation DepthShapesComponentsDos and Donts每个章节只需 2~4 句话说明这个令牌怎么用。例如 Colors 章节直接解释每个色板的用途这样代理才能把数值用对地方。五、第 3 步用 lint 命令通过校验在文件旁运行npx google/design.md lint DESIGN.md输出是结构化 JSON包含findings问题列表和summary错误/警告/信息统计。退出码为 0 代表无 error即通过校验六、常见 lint 警告速查表linter 共 11 条规则新手最常遇到这几种规则级别触发场景修复方法broken-referror{colors.primary}指向不存在的令牌检查令牌名拼写missing-primarywarning有颜色但没有primary补一个 primary 色板contrast-ratiowarning组件背景/文字对比度低于 WCAG AA4.5:1调整配色或换浅色文字section-orderwarning章节顺序不对按上面 8 节顺序重排orphaned-tokenswarning定义了颜色却没被组件引用在 components 中引用它参考实现packages/cli/src/linter/fixtures/HERITAGE.md 是一份能跑通的完整样例。七、进阶玩法diff 与 export对比版本npx google/design.md diff DESIGN.md DESIGN-v2.md—— 检测令牌级回归适合设计系统迭代时当 CI 卡点导出主题npx google/design.md export --format json-tailwind DESIGN.md—— 直接把令牌转成 Tailwind v3 配置或 DTCG tokens.json详见 README.md 的 CLI Reference 一节八、想抄作业看这三份官方示例仓库的 examples/ 目录收录了三套真实风格的设计系统文件建议对照学习毛玻璃天气应用examples/atmospheric-glass/DESIGN.md宠物出行品牌examples/paws-and-paths/DESIGN.md日全食音乐节examples/totaleity-festival/DESIGN.md也可以克隆仓库本地研究只读使用即可git clone https://gitcode.com/GitHub_Trending/de/design.md小结步骤动作验收1写 YAML 令牌含 primary 颜色 typography2按 8 节顺序写正文每个令牌都有用途说明3lint校验退出码 0errors 为 0按这三步走你的第一份 DESIGN.md 设计系统文件就能通过 lint 校验让 AI 代理从此看得懂你的品牌 【免费下载链接】design.mdA format specification for describing a visual identity to coding agents. DESIGN.md gives agents a persistent, structured understanding of a design system.项目地址: https://gitcode.com/GitHub_Trending/de/design.md创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考

相关新闻

YOLOv5钢材表面缺陷检测系统:从NEU-DET数据到工业部署全流程

YOLOv5钢材表面缺陷检测系统:从NEU-DET数据到工业部署全流程

简介:本资源是一套面向工业质检场景的YOLOv5钢材表面缺陷检测系统完整实现,适用于深度学习初学者、计算机视觉工程师及智能制造领域研究者,解决钢铁生产中常见划痕、凹坑、裂纹等表面缺陷的自动化识别问题。压缩包共5528个文件,涵…

2026/11/17 6:03:23 阅读更多 →
双端原生社交APP源码深度解析:音视频链路与IM即时通信架构

双端原生社交APP源码深度解析:音视频链路与IM即时通信架构

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

2026/11/6 6:02:12 阅读更多 →
POSIX Shell脚本跨平台兼容:Linux与macOS通用避坑指南

POSIX Shell脚本跨平台兼容:Linux与macOS通用避坑指南

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

2026/10/26 12:44:50 阅读更多 →

最新新闻

Electron桌面应用开发实战:从环境搭建到打包发布全流程

Electron桌面应用开发实战:从环境搭建到打包发布全流程

做前端这些年,我大部分时间都在跟浏览器标签页打交道,直到第一次把桌面应用跑起来,才发现原来自己一直被限制在地址栏和刷新按钮围起来的框框里。Electron这个词,最开始是在某段时间频繁出现在同事的讨论里,一个用HTML…

2026/11/16 8:22:12 阅读更多 →
滑盖智能锁T109深度解析:结构原理、安装调试与故障排查

滑盖智能锁T109深度解析:结构原理、安装调试与故障排查

简介:亚太天能T109滑盖智能锁产品说明书是一份PDF格式的官方技术文档,主要面向智能锁安装人员、终端用户及售后维护者,帮助快速掌握产品安装、配置与常见故障处理。全包仅1个PDF文件,大小4.37MB,内容结构清晰&#xff…

2026/11/16 6:41:34 阅读更多 →
PMSM弱磁控制原理与Simulink建模:高速AGV驱动系统设计指南

PMSM弱磁控制原理与Simulink建模:高速AGV驱动系统设计指南

上个月我在调试一台高速AGV的驱动系统,整车要求空载跑到8m/s,电机转速已经拉到额定点,驱动器的输出电压也顶到了母线电压极限附近。再往上踩速度指令,转速纹丝不动,三相电流反而开始震荡。那会儿我的第一反应就是&…

2026/11/16 8:22:12 阅读更多 →
C++核心知识点:从内存管理到STL的实战指南

C++核心知识点:从内存管理到STL的实战指南

C 这门语言我前前后后折腾了十几年,用它写过嵌入式驱动、做过游戏服务端,也搭过基础组件库。每次看到新人一头扎进"C 核心知识点"这个搜索词,我其实挺感慨的——这门语言的难点从来不是语法多,而是知识点之间的耦合太深…

2026/11/16 8:22:12 阅读更多 →
T109滑盖智能锁怎么装?安装调试与故障排查全攻略

T109滑盖智能锁怎么装?安装调试与故障排查全攻略

简介:亚太天能T109滑盖智能锁产品说明书以PDF格式发布,适合智能锁用户、安装人员与售后维修人员阅读。内容围绕T109系列指纹密码刷卡锁展开,先介绍前面板、后面板、锁体、机械钥匙、电池盒盖等部件名称与功能,再给出完整安装步骤&…

2026/11/16 7:30:18 阅读更多 →
LLM知识降熵:从信息垄断到理解权下放

LLM知识降熵:从信息垄断到理解权下放

你有没有过这种经历:翻开源码注释、论文摘要或者一份专业报告,每个字都认识,连在一起却像天书。想找人聊聊,身边要么没人懂,要么懂的懒得跟你解释。后来我试着把同一段内容丢给一个大语言模型,几秒钟之后&a…

2026/11/16 8:22:12 阅读更多 →

日新闻

周新闻

月新闻