8bit-docs-patterns

用途

8bit-docs-patterns 用于指导如何为 8-bit 复古游戏风格的 UI 组件编写文档。它面向需要记录游戏化区块（gaming blocks）、RPG 组件或复古风格界面的开发者，帮助文档在内容与形式上同时体现游戏和复古特色。

主要能力

该模式提供以下文档编写要点：

• 游戏术语：在描述和示例中使用游戏相关语言，例如将组件描述为“8-bit 任务与目标追踪系统”。
• 真实游戏数据：示例中使用有意义的游戏场景数据，如任务标题“Defeat the Goblin King”、状态“active/completed”等。
• 生命条示例：展示默认与复古变体，使用真实生命值（如 75、25）并配合上下文说明。
• 像素字体用法：通过 .retro 类应用像素字体样式。
• 包装器意识：8-bit 组件包装了 shadcn/ui，必须从 @/components/ui/8bit/ 导入，而非基础 shadcn 路径。
• retro.css 依赖：所有 8-bit 组件都需要引入 @/components/ui/8bit/styles/retro.css。
• 多变体展示：在文档中同时展示默认与 retro 变体。
• 游戏区块文档：针对由多个组件组成的区块（如任务日志、排行榜）提供文档模式。

使用方式

编写文档时，可参考以下模式：

1. 在 frontmatter 中设置标题和描述，使用游戏化措辞。
2. 在示例中传入真实的游戏数据对象。
3. 使用 ComponentPreview 包裹组件预览，并指定 title 与 name。
4. 对需要像素字体的文本添加 retro 类。
5. 从 @/components/ui/8bit/ 导入组件，并确保引入 retro.css。
6. 对同一组件的不同变体分别展示并配以说明文字。

参考示例文件包括：

• content/docs/blocks/gaming/quest-log.mdx
• content/docs/components/health-bar.mdx
• content/docs/blocks/gaming/leaderboard.mdx

适用场景

适用于为 8-bit 游戏风格组件库编写文档，尤其是涉及任务追踪、生命值显示、排行榜等游戏化界面的场景。

限制

资料未提供该模式的安装方式、收费信息、平台支持范围或具体效果数据，这些内容暂未提供。