From fcf7a91bb4a7bbf9e2335d9bdfe7b2eefccb7e77 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=B4=A4=E5=BF=83?= <3277200+sentsim@users.noreply.github.com> Date: Thu, 27 Feb 2025 14:19:04 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=96=B0=E5=A2=9E=20AI=20Agent=20?= =?UTF-8?q?=E7=94=9F=E6=88=90=E6=96=87=E6=A1=A3=E6=8F=90=E7=A4=BA=E8=AF=8D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.layui/detail/demo.md | 21 +++++++++++++++++++++ docs/.layui/prompt.txt | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+) create mode 100644 docs/.layui/detail/demo.md create mode 100644 docs/.layui/prompt.txt diff --git a/docs/.layui/detail/demo.md b/docs/.layui/detail/demo.md new file mode 100644 index 00000000..5c3a8d97 --- /dev/null +++ b/docs/.layui/detail/demo.md @@ -0,0 +1,21 @@ +
+ ++ +
+ ++ +
+ +diff --git a/docs/.layui/prompt.txt b/docs/.layui/prompt.txt new file mode 100644 index 00000000..e64eee10 --- /dev/null +++ b/docs/.layui/prompt.txt @@ -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 模板混合编写。