mirror of
https://github.com/luongnv89/claude-howto.git
synced 2026-07-07 11:17:48 +02:00
89e89d4aa3
Add Chinese (Simplified) translations for all documentation, organized under a dedicated zh/ directory that mirrors the English folder structure. Co-authored-by: tanqingkuang <tanqingkuang@users.noreply.github.com> Translations originally contributed by @tanqingkuang in #45. Restructured from *-CN.md suffix pattern into zh/ directory to prevent the EPUB builder (scripts/build_epub.py collect_folder_files) from picking up Chinese files via glob("*.md") inside module folders.
448 B
448 B
description
| description |
|---|
| 根据源代码生成完整的 API 文档 |
API 文档生成器
按以下步骤生成 API 文档:
- 扫描
/src/api/下的所有文件 - 提取函数签名和 JSDoc 注释
- 按端点/模块进行组织
- 生成带示例的 Markdown
- 包含请求/响应 Schema
- 添加错误文档
输出格式:
- 输出为
/docs/api.md中的 Markdown 文件 - 为所有端点加入 curl 示例
- 添加 TypeScript 类型