Back to Details

generate-component-documentation

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Instructions

说明

When generating documentation for a new component:

Follow existing patterns: Use the documentation styles found in the
```
docs
```
folder (examples:
```
button.md
```
,
```
accordion.md
```
, etc.)
Reference implementations: Base the documentation on the same-named story implementation in
```
crates/story/src/stories
```
API references: Use markdown
```
code
```
blocks with links to docs.rs for component API references when applicable

为新组件生成文档时：

遵循现有模式：使用
```
docs
```
文件夹中的文档样式（示例：
```
button.md
```
、
```
accordion.md
```
等）
参考实现代码：基于
```
crates/story/src/stories
```
中同名的story实现来编写文档
API参考：在适用时，使用markdown
```
code
```
块并链接到docs.rs来提供组件API参考

Examples

示例

The generated documentation should include:

Component description and purpose
Props/API documentation
Usage examples
Visual examples (if applicable)

生成的文档应包含：

组件描述和用途
属性/API文档
使用示例
视觉示例（如适用）