@aigne/doc-smith 0.9.7-beta.2 → 0.9.7

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## [0.9.7](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.9.7-beta.3...v0.9.7) (2025-11-28)
+
+## [0.9.7-beta.3](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.9.7-beta.2...v0.9.7-beta.3) (2025-11-28)
+
+
+### Bug Fixes
+
+* ensure x-card data-image is accessible ([#341](https://github.com/AIGNE-io/aigne-doc-smith/issues/341)) ([9209990](https://github.com/AIGNE-io/aigne-doc-smith/commit/92099909d9b1a0d5760a9b9977c940287af1aaec))
+
 ## [0.9.7-beta.2](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.9.7-beta.1...v0.9.7-beta.2) (2025-11-28)
 
 

package/agents/update/update-single/update-single-document-detail.mjs

@@ -103,7 +103,11 @@ Your task is to remove ${DIAGRAM_PLACEHOLDER} and adjust the document context (b
 
 <user_feedback>
 {{feedback}}
-</user_feedback>`;
+</user_feedback>
+
+<output_constraints>
+- Do not provide any explanations; include only the document content itself
+</output_constraints>`;
   const deleteAgent = AIAgent.from({
     name: "deleteDiagram",
     description: "Remove a diagram from the document content",

package/agents/utils/check-detail-result.mjs

@@ -1,5 +1,5 @@
-import { checkMarkdown } from "../../utils/markdown-checker.mjs";
 import { buildAllowedLinksFromStructure } from "../../utils/docs-finder-utils.mjs";
+import { checkMarkdown } from "../../utils/markdown-checker.mjs";
 
 export default async function checkDetailResult({ documentStructure, reviewContent, docsDir }) {
   if (!reviewContent || reviewContent.trim() === "") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.9.7-beta.2",
+  "version": "0.9.7",
   "description": "AI-driven documentation generation tool built on the AIGNE Framework",
   "publishConfig": {
     "access": "public"

package/prompts/detail/custom/custom-components/x-card-usage-rules.md

@@ -9,6 +9,7 @@ XCard is individual link display card, suitable for displaying individual links
 - `data-icon` (optional): Icon identifier (e.g., lucide:icon-name or material-symbols:rocket-outline).
   - 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.
+  - Prefer to use image url from `<media_file_list>`.
   - **Requirement**: At least one of `data-icon` or `data-image` must be provided.
   - It's recommended to always provide data-icon.
 - `data-href` (optional): Navigation link for clicking the card or button.

package/utils/markdown-checker.mjs

@@ -308,6 +308,67 @@ async function checkRemoteImages(markdown, source, errorMessages) {
   }
 }
 
+async function checkXCardImage(markdown, source, errorMessages, markdownFilePath, baseDir) {
+  const imageRegex = /data-image="([^"]*)"/g;
+  let match;
+
+  while (true) {
+    match = imageRegex.exec(markdown);
+    if (match === null) break;
+    const imagePath = match[1].trim();
+
+    // Skip data URLs
+    if (/^data:/.test(imagePath)) continue;
+
+    if (isRelative(imagePath)) {
+      try {
+        let resolvedPath;
+        if (markdownFilePath) {
+          // Resolve relative to the markdown file's directory
+          const markdownDir = path.dirname(markdownFilePath);
+          resolvedPath = path.resolve(markdownDir, imagePath);
+        } else if (baseDir) {
+          // Resolve relative to the provided base directory
+          resolvedPath = path.resolve(baseDir, imagePath);
+        } else {
+          // Fallback to current working directory
+          resolvedPath = path.resolve(imagePath);
+        }
+
+        if (!fs.existsSync(resolvedPath)) {
+          errorMessages.push(
+            `Found invalid local image in ${source}: ${imagePath} - only valid media resources can be used`,
+          );
+        }
+      } catch {
+        errorMessages.push(
+          `Found invalid local image in ${source}: ${imagePath} - only valid media resources can be used`,
+        );
+      }
+    } else if (imagePath.startsWith("/")) {
+      try {
+        if (!fs.existsSync(imagePath)) {
+          errorMessages.push(
+            `Found invalid local image in ${source}: ${imagePath} - only valid media resources can be used`,
+          );
+        }
+      } catch {
+        errorMessages.push(
+          `Found invalid local image in ${source}: ${imagePath} - only valid media resources can be used`,
+        );
+      }
+    } else if (isRemoteFile(imagePath)) {
+      const isAvailable = await isRemoteFileAvailable(imagePath);
+      if (isAvailable) continue;
+      else {
+        errorMessages.push(
+          `Found invalid remote image in ${source}: ${imagePath} - only valid media resources can be used`,
+        );
+      }
+    }
+  }
+}
+
 /**
  * Check content structure and formatting issues
  * @param {string} markdown - The markdown content
@@ -449,6 +510,8 @@ export async function checkMarkdown(markdown, source = "content", options = {})
     // 3. Check remote images existence
     await checkRemoteImages(markdown, source, errorMessages);
 
+    await checkXCardImage(markdown, source, errorMessages, filePath, baseDir);
+
     // 4. Check content structure and formatting issues
     checkContentStructure(markdown, source, errorMessages);