8-bit Documentation Patterns 是一套用于编写 8-bit 复古游戏风格组件文档的模式集合,核心目标是让文档充分体现 8-bit 组件的游戏化与复古特性。
用途 该模式适用于为 8-bit 组件、游戏区块、RPG 组件或复古风格界面编写文档,帮助文档在说明功能的同时传达游戏氛围。
主要能力与要点
- 游戏化术语:在描述与示例中使用游戏相关语言,例如标题与描述可写成 “Quest Log / Displays an 8-bit mission and task tracking system.”。
- 真实游戏数据:示例中使用有意义的游戏场景数据,例如任务日志中列出 “Defeat the Goblin King”“Collect Dragon Scales” 等任务,包含 id、title、description、status、shortDescription 字段。
- 生命值条示例:使用真实的生命值数值与场景,例如 <HealthBar value={75} />,并区分默认生命值条与危急生命值(25%)、retro 变体。
- 像素字体:通过 .retro 类应用像素字体样式,如 <div className="flex justify-between text-sm mb-2 retro">。
- 包装器模式:8-bit 组件是对 shadcn/ui 的包装,导入必须来自 @/components/ui/8bit/button,而非基础 shadcn 组件。
- retro.css 感知:所有 8-bit 组件都依赖 retro.css,组件源码中需要 import "@/components/ui/8bit/styles/retro.css",文档展示使用 8-bit 组件的用法,如 <Button className="retro">START GAME</Button>。
- 多变体展示:同时展示默认与 retro 变体,例如在 ComponentPreview 中分别呈现默认生命值条与 retro 生命值条。
- 区块文档:针对由多个组件构成的区块(如 Quest Log),使用 ComponentPreview 并传入 title、name 以及数据。
- 参考示例:content/docs/blocks/gaming/quest-log.mdx(任务追踪模式)、content/docs/components/health-bar.mdx(生命值条变体)、content/docs/blocks/gaming/leaderboard.mdx(游戏列表模式)。
关键原则 使用游戏语境术语、展示真实数据、用 .retro 类实现复古样式、注意包装器导入路径、展示多种变体、处理多组件区块文档、突出 8-bit 独有特性。
适用场景 适合为游戏化组件库、8-bit 界面组件、RPG 风格区块编写文档时套用,尤其是需要统一文档风格并体现复古游戏氛围的项目。
限制 资料未提供该模式的安装方式、可运行代码包、具体支持的组件清单、平台限制或收费信息,暂未提供。