105 lines
1.5 KiB
JavaScript
105 lines
1.5 KiB
JavaScript
export const docTemplatesResource = {
|
|
uri: "devassistant://resources/doc-templates",
|
|
name: "文档模板",
|
|
description: "README、API 文档、CHANGELOG 等标准模板",
|
|
mimeType: "text/markdown",
|
|
};
|
|
export function getDocTemplates() {
|
|
return `# 文档模板集合
|
|
|
|
---
|
|
|
|
## README.md 模板
|
|
|
|
\`\`\`markdown
|
|
# 项目名称
|
|
|
|
简短的项目描述（一句话）。
|
|
|
|
## 功能特性
|
|
|
|
- 特性 1
|
|
- 特性 2
|
|
|
|
## 快速开始
|
|
|
|
### 环境要求
|
|
- Node.js >= 18
|
|
|
|
### 安装
|
|
\\\`\\\`\\\`bash
|
|
npm install
|
|
\\\`\\\`\\\`
|
|
|
|
### 配置
|
|
复制 \`.env.example\` 为 \`.env\`，填写配置。
|
|
|
|
### 运行
|
|
\\\`\\\`\\\`bash
|
|
npm start
|
|
\\\`\\\`\\\`
|
|
|
|
## 项目结构
|
|
\\\`\\\`\\\`
|
|
src/
|
|
├── index.ts # 入口
|
|
├── routes/ # 路由
|
|
├── services/ # 业务逻辑
|
|
└── utils/ # 工具函数
|
|
\\\`\\\`\\\`
|
|
|
|
## API 文档
|
|
见 [API.md](./API.md)
|
|
|
|
## License
|
|
MIT
|
|
\`\`\`
|
|
|
|
---
|
|
|
|
## API 文档模板
|
|
|
|
\`\`\`markdown
|
|
# API 文档
|
|
|
|
## Base URL
|
|
\\\`https://api.example.com/v1\\\`
|
|
|
|
## 认证
|
|
Header: \\\`Authorization: Bearer <token>\\\`
|
|
|
|
## 端点
|
|
|
|
### POST /endpoint
|
|
描述
|
|
|
|
**请求参数**
|
|
| 字段 | 类型 | 必填 | 描述 |
|
|
|------|------|------|------|
|
|
| name | string | 是 | 名称 |
|
|
|
|
**响应**
|
|
\\\`\\\`\\\`json
|
|
{ "code": 0, "data": {} }
|
|
\\\`\\\`\\\`
|
|
\`\`\`
|
|
|
|
---
|
|
|
|
## CHANGELOG 模板
|
|
|
|
\`\`\`markdown
|
|
# Changelog
|
|
|
|
## [1.0.0] - 2025-01-01
|
|
### Added
|
|
- 初始版本发布
|
|
- 功能 A
|
|
- 功能 B
|
|
|
|
### Fixed
|
|
- 修复问题 X
|
|
\`\`\`
|
|
`;
|
|
}
|
|
//# sourceMappingURL=docTemplates.js.map
|