@aigne/doc-smith 0.6.0 → 0.7.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.6.0",
+  "version": "0.7.1",
   "description": "",
   "publishConfig": {
     "access": "public"
@@ -12,19 +12,21 @@
   "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
   "license": "MIT",
   "dependencies": {
-    "@aigne/aigne-hub": "^0.6.10",
-    "@aigne/anthropic": "^0.11.10",
-    "@aigne/cli": "^1.41.1",
-    "@aigne/core": "^1.55.1",
-    "@aigne/gemini": "^0.9.10",
-    "@aigne/openai": "^0.12.4",
-    "@aigne/publish-docs": "^0.6.0",
+    "@aigne/aigne-hub": "^0.8.1",
+    "@aigne/anthropic": "^0.11.12",
+    "@aigne/cli": "^1.42.0",
+    "@aigne/core": "^1.57.0",
+    "@aigne/gemini": "^0.11.1",
+    "@aigne/openai": "^0.13.2",
+    "@aigne/publish-docs": "^0.8.0",
     "chalk": "^5.5.0",
     "dompurify": "^3.2.6",
+    "fs-extra": "^11.3.1",
     "glob": "^11.0.3",
     "jsdom": "^26.1.0",
     "mermaid": "^11.9.0",
     "open": "^10.2.0",
+    "p-map": "^7.0.3",
     "remark-gfm": "^4.0.1",
     "remark-lint": "^10.0.1",
     "remark-parse": "^11.0.0",
@@ -40,10 +42,11 @@
   },
   "scripts": {
     "test": "bun test",
+    "test:coverage": "bun test --coverage --coverage-reporter=lcov --coverage-reporter=text",
     "test:watch": "bun test --watch",
-    "lint": "biome check && pnpm -r run lint",
+    "lint": "biome check",
     "update:deps": "npx -y taze major -r -w -f -n '/@abtnode|@aigne|@arcblock|@blocklet|@did-connect|@did-pay|@did-space|@nft-store|@nft-studio|@ocap/' && pnpm install && pnpm run deduplicate",
     "deduplicate": "pnpm dedupe",
-    "lint:fix": "biome check --write && pnpm -r run lint"
+    "lint:fix": "biome check --write"
   }
 }

package/prompts/content-detail-generator.md

@@ -101,14 +101,18 @@ parentId: {{parentId}}
 
 </media_rules>
 
-{% include "../prompts/document/detail-generator.md" %}
+{% include "document/detail-generator.md" %}
+
+{% include "document/custom-components.md" %}
+
 </rules>
 
-{% include "../prompts/document/detail-example.md" %}
+{% include "document/detail-example.md" %}
 
 <output_schema>
 
 1. 输内容为{{nodeName}}的详细文本。
 2. 直接输出{{nodeName}}内容，不要包含其他信息.
 3. 仅参考示例中的风格，**以语言 {{locale}} 输出内容 **
-   </output_schema>
+
+</output_schema>

package/prompts/document/custom-components.md

@@ -0,0 +1,80 @@
+When generating document details, you can use the following custom components at appropriate locations based on their descriptions and functionality to enhance document presentation:
+- `<x-card>`
+- `<x-cards>`
+
+
+### 1. <x-card> Single Card Component
+Suitable for displaying individual links with a richer and more visually appealing presentation format.
+
+Example:
+
+```
+<x-card data-title="Required Title" data-image="Image URL" data-icon="Icon identifier (e.g., lucide:rocket or material-symbols:rocket-outline)" data-href="Navigation link URL" data-horizontal="true/false" data-cta="Button text" >
+  Card body content
+</x-card>
+```
+
+Attribute Rules:
+
+-	data-title (required): Card title.
+-	data-icon / data-image (choose one, at least one must be provided):
+    -	It's recommended to always provide data-icon.
+    -	Icons should prioritize Lucide (lucide:icon-name). If not available in Lucide, use Iconify (collection:icon-name, e.g., material-symbols:rocket-outline).
+-	data-image (optional): Image URL, can coexist with icon.
+-	data-href (optional): Navigation link for clicking the card or button.
+-	data-horizontal (optional): Whether to use horizontal layout.
+-	data-cta (optional): Button text (call to action).
+-	Body content: Must be written within <x-card>...</x-card> children.
+
+
+### 2. `<x-cards>` Card List Component
+
+Suitable for displaying multiple links using a card list format, providing a richer and more visually appealing presentation.
+
+Syntax:
+
+```
+<x-cards data-columns="Number of columns">
+  <x-card data-title="Title 1" data-icon="lucide:rocket">Content 1</x-card>
+  <x-card data-title="Title 2" data-icon="lucide:bolt">Content 2</x-card>
+  <x-card data-title="Title 3" data-icon="material-symbols:rocket-outline">Content 3</x-card>
+</x-cards>
+```
+
+Attribute Rules:
+-	data-columns (optional): Number of columns, integer (e.g., 2, 3). Default is 2.
+-	Must contain multiple <x-card> elements internally.
+-	Consistency requirement: All <x-card> elements within the same <x-cards> must maintain visual consistency:
+    -	Recommended to always provide data-icon for each card.
+    -	Or all cards should have data-image.
+    -	Avoid mixing (some with icons, some with only images).
+
+
+### 3. Examples
+
+Single card:
+
+```
+<x-card data-title="Horizontal card" data-icon="lucide:atom" data-horizontal="true">
+  This is an example of a horizontal card.
+</x-card>
+```
+
+Card list (all using icons, recommended approach):
+
+```
+<x-cards data-columns="3">
+  <x-card data-title="Feature 1" data-icon="lucide:rocket">Description of Feature 1.</x-card>
+  <x-card data-title="Feature 2" data-icon="lucide:bolt">Description of Feature 2.</x-card>
+  <x-card data-title="Feature 3" data-icon="material-symbols:rocket-outline">Description of Feature 3.</x-card>
+</x-cards>
+```
+
+Card list (all using images):
+
+```
+<x-cards data-columns="2">
+  <x-card data-title="Card A" data-image="https://picsum.photos/id/10/300/300">Content A</x-card>
+  <x-card data-title="Card B" data-image="https://picsum.photos/id/11/300/300">Content B</x-card>
+</x-cards>
+```

package/prompts/document/d2-chart/diy-examples.md

@@ -0,0 +1,44 @@
+- 结构图示例：
+  ```d2
+  App: Application
+  API: API Server
+  DB: Database
+
+  App -> API: 调用
+  API -> DB: 读写数据
+  ```
+- 流程图示例：
+  ```d2
+  start: 开始
+  input: 用户输入
+  process: 处理数据
+  output: 输出结果
+  end: 结束
+
+  start -> input -> process -> output -> end
+  ```
+- 时序图示例：
+  ```d2
+  User: 用户
+  Service: 服务
+  DB: 数据库
+
+  User -> Service: 请求
+  Service -> DB: 查询
+  DB -> Service: 返回数据
+  Service -> User: 响应
+  ```
+- 决策树示例：
+  ```d2
+  start: 开始
+  check: 是否有效？
+  yes: 是
+  no: 否
+  end: 结束
+
+  start -> check
+  check -> yes: 有效
+  check -> no: 无效
+  yes -> end
+  no -> end
+  ```