关于 docs-page
docs-page 是用于生成单文件三栏 HTML 文档页的设计技能,面向制作文档界面的场景。它规定导航、正文、目录的布局,以及样式、响应式行为和内容要求。
主要功能
- 01三栏文档页面布局
- 02单个 HTML 文件内嵌 CSS
- 03固定导航与页面目录
- 04适配 900px 以下视口
- 05内容与样式自检
适用场景
- 01根据需求简报生成文档页
- 02制作含示例的 API 文档
- 03按 DESIGN.md 应用页面样式
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ mphinance/ alpha-skills --skill docs-page安装后在 Claude Code 中输入/docs-page确认已加载。
附带文件example.htmlREADME.md
详细介绍
文档页面技能
在一个 HTML 文件中生成单页、三栏文档页面。
工作流
- 读取当前的 DESIGN.md(已在上方注入)。正文使用正文类型令牌;代码使用等宽字体令牌;遵循行高和最大宽度规则。
- 从需求简介中选择一个主题——页面应像真实文档,而不是通用线框图。使用具体的 API 名称、命令示例和合理的参数。
- 布局三个区域:
- 左侧导航(240–280px,粘性定位):分组链接列表,当前页面以粗体显示,并带有左侧边缘强调条。设置 3–5 个分组,每组 4–8 个链接。
- 文章正文(最大宽度约 720px,居中显示在中间列):H1、导语段落、H2 章节、代码块、提示框(备注/警告)、行内链接、列表。
- 右侧目录(200–240px,粘性定位):“本页内容”,包含 H2/H3 锚点;用户滚动时高亮当前章节。
- 编写单个 HTML 文档:
- 从
<!doctype html>到</html>,所有 CSS 均内联。 - 使用 CSS Grid 划分三栏;两侧栏采用粘性定位。
- 代码块使用等宽字体令牌和柔和的表面填充,并提供复制按钮样式(仅视觉效果——无需 JS)。
- 为每个 H2/H3 添加锚点 ID,使目录链接可用。
- 在导航、文章和目录上添加
data-od-id。
- 从
- 正文:撰写至少 350 词可信的文档内容。至少包含一条 shell 命令、一段代码片段(5–15 行)、一个提示框和一张表格。
- 自检:
- 正文按照 DS 的理想行长换行(60–75 个字符)。
- 代码使用 DS 等宽字体令牌,而非通用的
monospace。 - 强调色使用克制——用于当前导航项、链接和一个提示框边框。不要用于正文。
- 页面在 1280w 下易于阅读,并能在 900w 以下优雅折叠(目录隐藏,导航变为顶部抽屉)。
输出约定
在 <artifact> 标签之间输出:
<artifact identifier="docs-slug" type="text/html" title="Docs — Page Title">
<!doctype html>
<html>...</html>
</artifact>
在产物前写一个句子,产物后不写任何内容。
评论
支持 Markdown