mcpField
T
tailwind-4-docs

tailwind-4-docs

github.com/lombiq设计与 UI7717.8k 次安装29 周前更新
代码仓库

关于 tailwind-4-docs

使用本地同步的文档快照回答 Tailwind CSS v4 开发问题的技能,为配置、实现、迁移、重构和审查提供指引。

主要功能

  1. 01检索本地文档索引
  2. 02仅加载相关文档
  3. 03提供 v3 到 v4 迁移指导
  4. 04代码任务工程实践指南
  5. 05可刷新的文档快照

适用场景

  1. 01核对 Tailwind v4 配置
  2. 02规划 v3 到 v4 升级
  3. 03审查或重构 Tailwind 代码

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/lombiq/tailwind-agent-skills --skill tailwind-4-docs

安装后在 Claude Code 中输入/tailwind-4-docs确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

references/
docs-source.txt
engineering-playbook.md
gotchas.md
scripts/
sync_tailwind_docs.py

详细介绍

Tailwind 4 文档

概述

使用此技能浏览本地同步的 Tailwind CSS v4 文档快照,并依据官方指南回答开发、配置、迁移、实现、重构和审查相关问题。

此技能不附带文档快照,因为上游仓库可查看源代码,但并非开源。用户必须自行初始化快照,并负责遵守上游许可证。

快速开始

  1. 检查文档快照是否已初始化(references/docs/ 和 references/docs-index.tsx 是否存在)。
  2. 如果快照缺失或超过一周未更新,请停止并要求先运行“初始化”中的步骤。快照初始化完成前,不要回答用户的问题。
  3. 确定主题(工具类、变体、配置、迁移、兼容性、实现、重构、审查)。
  4. 在 references/docs-index.tsx 中查找匹配的文档。
  5. 仅加载 references/docs/ 中相关的文件。
  6. 对于实现、重构或审查任务,还要加载 references/engineering-playbook.md。
  7. 应用指南,并指出任何破坏性变更或限制。

初始化(每次安装时必须执行一次)

运行同步脚本,在本地下载 Tailwind 文档。此操作需要网络访问、git 和 Python 3:

python skills/tailwind-4-docs/scripts/sync_tailwind_docs.py --accept-docs-license

此操作会从 tailwindlabs/tailwindcss.com 拉取内容。该仓库可查看源代码,且明确声明并非开源,因此用户必须在下载前接受其许可证,并将快照保留在本地。

如果你无法运行工具或无法访问互联网,请让用户在终端中运行上方的确切命令,然后在 references/docs/ 和 references/docs-index.tsx 存在后继续。

如果快照缺失或超过一周未更新,你必须请求许可后再运行命令,或请用户运行命令。快照初始化或刷新之前,不要提供 Tailwind 相关指导。

如果初始化受阻(无网络或无写入权限),请将 references/gotchas.md 作为有限的备用资料,并请用户查阅官方文档。对于实现、重构或审查任务,references/engineering-playbook.md 也可作为有限的备用资料。

参考资料索引

  • references/docs/ 在本地生成,包含 Tailwind v4 MDX 文档快照。
  • references/docs-index.tsx 在本地生成,包含文档侧边栏使用的类别和 slug 映射。
  • references/docs-source.txt 记录上游仓库、提交和快照日期(或说明初始化仍待完成)。
  • references/engineering-playbook.md 是面向 Agent 的实现、重构和审查指南。
  • references/gotchas.md 快速汇总了 v4 迁移中的常见陷阱。

MDX 处理

  • 将 export const title 和 export const description 视为元数据。
  • 将 <TipInfo> 或 <TipBad> 等 JSX 提示框中的内容视为指导文本。

常见入口

  • 迁移:references/docs/upgrade-guide.mdx、references/docs/compatibility.mdx。
  • 实现/重构/审查:references/engineering-playbook.md。
  • 陷阱概览:references/gotchas.md。
  • 配置和指令:references/docs/functions-and-directives.mdx、references/docs/adding-custom-styles.mdx、references/docs/theme.mdx。
  • 变体和响应式模式:references/docs/hover-focus-and-other-states.mdx、references/docs/responsive-design.mdx。
  • 核心行为:references/docs/preflight.mdx、references/docs/detecting-classes-in-source-files.mdx。

迁移清单

从 v3 升级到 v4 时,请务必在文档中确认以下内容:

  • 浏览器支持和兼容性预期。
  • 工具变更:@tailwindcss/postcss、@tailwindcss/cli、@tailwindcss/vite。
  • 导入语法:@import "tailwindcss" 取代 @tailwind 指令。
  • 工具类重命名或移除、前缀格式,以及 important 修饰符的位置。
  • 变体、变换和任意值语法的变更。

更新工作流

运行 scripts/sync_tailwind_docs.py 刷新快照。如果你已在本地克隆 tailwindlabs/tailwindcss.com,请使用 --local-repo 加快同步。务必传入 --accept-docs-license。


评论

支持 Markdown