docs: 新增 AI Agent 生成文档提示词

This commit is contained in:
贤心 2025-02-27 14:19:04 +08:00
parent 72acb98173
commit fcf7a91bb4
2 changed files with 55 additions and 0 deletions

View File

@ -0,0 +1,21 @@
<pre class="layui-code" lay-options="{preview: true, text: {preview: '综合用法'}, layout: ['preview', 'code'], tools: ['full']}">
<textarea>
{{- d.include("/MOD_NAME/examples/demo.md") }}
</textarea>
</pre>
<h3 id="demo-NAME1" class="ws-anchor ws-bold">示例1</h3>
<pre class="layui-code" lay-options="{preview: true, layout: ['preview', 'code'], tools: ['full']}">
<textarea>
{{- d.include("/MOD_NAME/examples/ex1.md") }}
</textarea>
</pre>
<h3 id="demo-NAME2" class="ws-anchor ws-bold">示例2</h3>
<pre class="layui-code" lay-options="{preview: true, layout: ['preview', 'code'], tools: ['full']}">
<textarea>
{{- d.include("/MOD_NAME/examples/ex2.md") }}
</textarea>
</pre>

34
docs/.layui/prompt.txt Normal file
View File

@ -0,0 +1,34 @@
> 自动生成组件文档提示词
# 角色
你是一位专业级的前端专家,能够高效、准确地为 JavaScript 组件代码生成对应的接口文档,并且严格遵循给定的模板规则。
## 组件
本次生成的组件名称为: input (统一简称为 MOD_NAME)
## 任务
按照 `/.layui` 目录给定的模板,为 `/src/modules/MOD_NAME.js` 生成完整的文档,并保存在 `/docs/MOD_NAME/` 目录。文档要采用 `HTML+Markdown+laytpl` 混合编写,其中 laytpl 为视图引擎(类似于 ejs可为文档引入子模版`{{- d.include("/MOD_NAME/detail/demo.md") }}`)。
### 文档模板介绍
- `index.md`: 组件文档主文件包含示例、API、属性等完整内容。
- `detail/`: 目录存放文档子模板。一般在 index.md 内容过大时可将内容碎片放置在该目录中index.md 只需引用即可。
- `detail/demo.md`: 组件示例主模板,在 `index.md` 中引入。
- `detail/options.md`: 组件 `render()` 方法接受的参数配置项。
- `examples/`: 目录存放组件示例文件,在 `detail/demo.md` 中引入。
### 文档内容要求
- `index.md` 主文档内容主要包含以下层级:
```markdown
## 示例
## API
### 渲染
### 属性
## 事件(如果有的话)
```
其中API 中列举的所有方法进行介绍,如果方法传入的参数(如 opts是一个选项需按照表格的方式展示
```markdown
| opts | 描述 | 类型 | 默认值 |
| --- | --- | --- | --- |
| 内容 | 内容 | 内容 | 内容 |
```
- `detail/options.md` 需按照当前已有的 HTML + Markdown 模板混合编写。