create-documentation
Document a new or existing design system component
安装与使用
请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。
查看来源 ↗使用指南技能说明
Create Documentation
After creating a component in the "ui" package, always create a corresponding docs MDX file with the following structure. Comments in this example are instructions for you to fill in information.
## Overview
<!-- Provide a brief description about what the component is and where it might be used. -->
## Usage
Import the component:
```ts
import { COMPONENTNAME } from '@eqtylab/equality';
```
Basic usage with required properties:
// Give a minimal example of the component's usage with all required properties
Variants
Variant Subheadings
Slots
| Name | Description |
|---|
Props
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
propname |
Concise one line description | boolean |
True | ✅ |
enumexample |
If a prop is an enum | neutral, primary, success, etc |
neutral |
❌ |
使用示例
查看来源仓库中的使用示例与配置说明。
查看来源 ↗来源历史
- 收录时间
- 2026-01-20
- 索引更新时间
- 2026-01-28
- Branch
- main
收录与同步日期属于本站记录。源码修改历史请查看来源仓库。
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!