@qualcomm-ui/mdx-vite 2.7.0 → 2.8.0

package/dist/cli.js

@@ -3604,6 +3604,7 @@ function defined(value) {
 }
 var frontmatterSchema = implement().with({
   categories: z3.string().array().optional(),
+  description: z3.string().optional(),
   group: z3.string().optional(),
   hidden: z3.boolean().optional(),
   hideBreadcrumbs: z3.boolean().optional(),
@@ -5036,6 +5037,7 @@ var SearchIndexer = class {
         this.metaJson,
         routeMeta?.title || frontmatter.title || ""
       ),
+      description: frontmatter.description,
       hidden: defined(routeMeta.hidden) ? routeMeta.hidden : frontmatter.hidden,
       hideBreadcrumbs: defined(routeMeta.hideBreadcrumbs) ? routeMeta.hideBreadcrumbs : frontmatter.hideBreadcrumbs,
       hideFromSearch: defined(routeMeta.hideFromSearch) ? routeMeta.hideFromSearch : frontmatter.hideFromSearch,
@@ -5628,7 +5630,7 @@ import remarkParse4 from "remark-parse";
 import remarkParseFrontmatter2 from "remark-parse-frontmatter";
 import remarkStringify3 from "remark-stringify";
 import { unified as unified4 } from "unified";
-import { visit as visit7 } from "unist-util-visit";
+import { visit as visit8 } from "unist-util-visit";
 import { kebabCase } from "@qualcomm-ui/utils/change-case";
 
 // src/docs-plugin/docs-plugin.ts
@@ -5795,9 +5797,12 @@ import { headingRank as headingRank2 } from "hast-util-heading-rank";
 // src/docs-plugin/remark/remark-code-tabs.ts
 import { visit as visit4 } from "unist-util-visit";
 
+// src/docs-plugin/remark/remark-frontmatter-description.ts
+import { visit as visit5 } from "unist-util-visit";
+
 // src/docs-plugin/remark/remark-self-link-headings.ts
 import { toString as toString2 } from "mdast-util-to-string";
-import { visit as visit5 } from "unist-util-visit";
+import { visit as visit6 } from "unist-util-visit";
 var emptyOptions2 = {};
 function remarkSelfLinkHeadings(baseUrl = "", options) {
   if (!baseUrl) {
@@ -5825,7 +5830,7 @@ function remarkSelfLinkHeadings(baseUrl = "", options) {
     }
     return (tree) => {
       seenIds.clear();
-      visit5(tree, "heading", (node) => {
+      visit6(tree, "heading", (node) => {
         if (allowedLevels.has(node.depth)) {
           const text = toString2(node);
           const slug = prefix + createSlug(text);
@@ -5842,7 +5847,7 @@ function remarkSelfLinkHeadings(baseUrl = "", options) {
 }
 
 // src/docs-plugin/remark/remark-spoilers.ts
-import { visit as visit6 } from "unist-util-visit";
+import { visit as visit7 } from "unist-util-visit";
 
 // src/docs-plugin/shiki/shiki-transformer-preview-block.ts
 import { dedent } from "@qualcomm-ui/utils/dedent";
@@ -5954,7 +5959,7 @@ function extractMetadata(metadata) {
 }
 var replaceNpmInstallTabs = () => {
   return (tree, _file, done) => {
-    visit7(tree, "mdxJsxFlowElement", (node) => {
+    visit8(tree, "mdxJsxFlowElement", (node) => {
       if (node?.name === "NpmInstallTabs") {
         const packages = node.attributes?.find(
           (attr) => attr.type === "mdxJsxAttribute" && attr.name === "packages"
@@ -6270,7 +6275,7 @@ ${codeText}
       }
     };
     return () => (tree, _file, done) => {
-      visit7(tree, "mdxJsxFlowElement", (node) => {
+      visit8(tree, "mdxJsxFlowElement", (node) => {
         const handler = node.name && handlers[node.name];
         if (!handler) {
           return;
@@ -6310,7 +6315,7 @@ ${codeText}
    */
   replaceTypeDocProps() {
     return () => (tree, _file, done) => {
-      visit7(
+      visit8(
         tree,
         "mdxJsxFlowElement",
         (node, index, parent) => {
@@ -6371,7 +6376,7 @@ ${codeText}
   replaceDemos(demosFolder, demoFiles) {
     return () => async (tree) => {
       const promises = [];
-      visit7(
+      visit8(
         tree,
         "mdxJsxFlowElement",
         (node, index, parent) => {
@@ -6459,11 +6464,32 @@ ${codeText}
       await Promise.all(promises);
     };
   }
+  replaceFrontmatterDescription(frontmatter) {
+    return () => (tree) => {
+      visit8(
+        tree,
+        "mdxFlowExpression",
+        (node, index, parent) => {
+          if (node.value.trim() !== "frontmatter.description" || index === void 0 || !parent) {
+            return;
+          }
+          if (frontmatter.description) {
+            parent.children.splice(index, 1, {
+              children: [{ type: "text", value: frontmatter.description }],
+              type: "paragraph"
+            });
+          } else {
+            parent.children.splice(index, 1);
+          }
+        }
+      );
+    };
+  }
   /**
    * Processes MDX content by transforming JSX elements (TypeDocProps, demos)
    * into markdown, resolving relative links, and cleaning up formatting.
    */
-  async processMdxContent(mdxContent, pageUrl, demosFolder) {
+  async processMdxContent(mdxContent, pageUrl, demosFolder, frontmatter) {
     const demoFiles = [];
     let processedContent = mdxContent;
     const lines = processedContent.split("\n");
@@ -6473,7 +6499,7 @@ ${codeText}
       /\[([^\]]+)\]\(\.\/#([^)]+)\)/g,
       (_, text, anchor) => pageUrl && this.config.outputMode === "per-page" ? `[${text}](${pageUrl}#${anchor})` : text
     );
-    const processor = unified4().use(remarkParse4).use(remarkMdx3).use(this.replaceTypeDocProps()).use(await this.replaceThemeNodes()).use(this.replaceDemos(demosFolder, demoFiles)).use(remarkStringify3);
+    const processor = unified4().use(remarkParse4).use(remarkMdx3).use(this.replaceTypeDocProps()).use(this.replaceFrontmatterDescription(frontmatter)).use(await this.replaceThemeNodes()).use(this.replaceDemos(demosFolder, demoFiles)).use(remarkStringify3);
     const processed = await processor.process(processedContent);
     processedContent = String(processed);
     processedContent = processedContent.replace(/\n\s*\n\s*\n/g, "\n\n");
@@ -6495,7 +6521,8 @@ ${codeText}
       const { content: processedContent, demoFiles } = await this.processMdxContent(
         String(parsed),
         component.url,
-        component.demosFolder
+        component.demosFolder,
+        frontmatter
       );
       const removeJsxProcessor = unified4().use(remarkParse4).use(remarkMdx3).use(remarkRemoveJsx).use(remarkStringify3);
       const removedJsx = String(