@mui/internal-docs-infra 0.3.1-canary.1 → 0.3.1-canary.2

package/esm/createSitemap/types.d.ts

@@ -35,15 +35,9 @@ export interface SitemapPage {
   exports?: Record<string, SitemapExport>;
   tags?: string[];
   skipDetailSection?: boolean;
-  openGraph?: {
-    title?: string;
-    description?: string;
-    images?: Array<{
-      url: string;
-      width: number;
-      height: number;
-      alt: string;
-    }>;
+  image?: {
+    url: string;
+    alt?: string;
   };
 }
 /**

package/esm/pipeline/syncPageIndex/mergeMetadataMarkdown.js

@@ -68,7 +68,6 @@ function _mergeMetadataMarkdown() {
       _step2,
       existingPage,
       newPage,
-      _newPage$openGraph,
       descriptionMarkdown,
       existingPageWithoutDescriptionMarkdown,
       merged,
@@ -148,11 +147,7 @@ function _mergeMetadataMarkdown() {
                   // Preserve skipDetailSection from existing (user-managed for external links)
                   skipDetailSection: existingPage.skipDetailSection,
                   // Preserve sections from existing if new doesn't have them
-                  sections: newPage.sections || existingPage.sections,
-                  // Merge openGraph, but ensure description comes from newPage if it has one
-                  openGraph: (_newPage$openGraph = newPage.openGraph) != null ? _newPage$openGraph : newPage.description ? _extends(_extends({}, existingPage.openGraph), {}, {
-                    description: newPage.description
-                  }) : existingPage.openGraph
+                  sections: newPage.sections || existingPage.sections
                 });
                 pages.push(merged);
                 addedPaths.add(newPage.path);

package/esm/pipeline/syncPageIndex/metadataToMarkdown.js

@@ -429,9 +429,8 @@ export function metadataToMarkdownAst(data) {
     _step5;
   try {
     for (_iterator5.s(); !(_step5 = _iterator5.n()).done;) {
-      var _page$openGraph;
       var page = _step5.value;
-      var pageTitle = ((_page$openGraph = page.openGraph) == null ? void 0 : _page$openGraph.title) || page.title || page.slug;
+      var pageTitle = page.title || page.slug;
 
       // Check if this is a single-link entry (external link or no detail section)
       var isSingleLink = page.skipDetailSection || false;
@@ -511,13 +510,12 @@ export function metadataToMarkdownAst(data) {
     _step6;
   try {
     for (_iterator6.s(); !(_step6 = _iterator6.n()).done;) {
-      var _page$openGraph2, _page$openGraph3, _page$openGraph4;
       var _page = _step6.value;
-      var _pageTitle = ((_page$openGraph2 = _page.openGraph) == null ? void 0 : _page$openGraph2.title) || _page.title || _page.slug;
+      var _pageTitle = _page.title || _page.slug;
       // Note: We don't replace newlines here to allow natural line breaks in detailed sections
-      var description = ((_page$openGraph3 = _page.openGraph) == null ? void 0 : _page$openGraph3.description) || _page.description || 'No description available';
+      var description = _page.description || 'No description available';
       var keywords = _page.keywords || [];
-      var image = (_page$openGraph4 = _page.openGraph) == null || (_page$openGraph4 = _page$openGraph4.images) == null ? void 0 : _page$openGraph4[0];
+      var image = _page.image;
 
       // Add page heading
       children.push(heading(2, _pageTitle));
@@ -800,9 +798,8 @@ export function metadataToMarkdown(data) {
     _step9;
   try {
     for (_iterator9.s(); !(_step9 = _iterator9.n()).done;) {
-      var _page$openGraph5;
       var page = _step9.value;
-      var pageTitle = ((_page$openGraph5 = page.openGraph) == null ? void 0 : _page$openGraph5.title) || page.title || page.slug;
+      var pageTitle = page.title || page.slug;
 
       // Check if this is a single-link entry (external link or no detail section)
       var isSingleLink = page.skipDetailSection || false;
@@ -871,24 +868,22 @@ export function metadataToMarkdown(data) {
     _step0;
   try {
     for (_iterator0.s(); !(_step0 = _iterator0.n()).done;) {
-      var _page2$openGraph, _page2$openGraph3;
       var _page2 = _step0.value;
       // Skip detail section for single-link entries (external links)
       if (_page2.skipDetailSection) {
         continue;
       }
-      var _pageTitle2 = ((_page2$openGraph = _page2.openGraph) == null ? void 0 : _page2$openGraph.title) || _page2.title || _page2.slug;
+      var _pageTitle2 = _page2.title || _page2.slug;
       // Use descriptionMarkdown to preserve formatting if available
       // Note: We don't replace newlines here to allow natural line breaks in detailed sections
       var pageDescription = void 0;
       if (_page2.descriptionMarkdown && _page2.descriptionMarkdown.length > 0) {
         pageDescription = astNodesToMarkdown(_page2.descriptionMarkdown);
       } else {
-        var _page2$openGraph2;
-        pageDescription = ((_page2$openGraph2 = _page2.openGraph) == null ? void 0 : _page2$openGraph2.description) || _page2.description || 'No description available';
+        pageDescription = _page2.description || 'No description available';
       }
       var keywords = _page2.keywords || [];
-      var image = (_page2$openGraph3 = _page2.openGraph) == null || (_page2$openGraph3 = _page2$openGraph3.images) == null ? void 0 : _page2$openGraph3[0];
+      var image = _page2.image;
 
       // Add page heading
       lines.push("## ".concat(_pageTitle2));
@@ -1164,12 +1159,7 @@ function _markdownToMetadata() {
                     title: pageTitle,
                     description: 'No description available',
                     tags: tags.length > 0 ? tags : undefined,
-                    skipDetailSection: true,
-                    // Mark as external/single-link entry
-                    openGraph: {
-                      title: pageTitle,
-                      description: 'No description available'
-                    }
+                    skipDetailSection: true // Mark as external/single-link entry
                   });
                 } else if (links.length >= 2) {
                   // Two-link format: - [Title](#slug) [Tag1] [Tag2] - [Full Docs](./path/page.mdx)
@@ -1221,11 +1211,7 @@ function _markdownToMetadata() {
                     title: _pageTitle3,
                     description: 'No description available',
                     // Will be updated from details section
-                    tags: _tags.length > 0 ? _tags : undefined,
-                    openGraph: {
-                      title: _pageTitle3,
-                      description: 'No description available' // Will be updated from details section
-                    }
+                    tags: _tags.length > 0 ? _tags : undefined
                   });
                 }
               }
@@ -1329,10 +1315,6 @@ function _markdownToMetadata() {
                   if (_paragraphNode2.children) {
                     currentPage.descriptionMarkdown = stripPositions(_paragraphNode2.children);
                   }
-                  if (!currentPage.openGraph) {
-                    currentPage.openGraph = {};
-                  }
-                  currentPage.openGraph.description = _paragraphText;
                   return;
                 }
               }
@@ -1340,15 +1322,10 @@ function _markdownToMetadata() {
               // Parse image
               if (currentPage && node.type === 'image') {
                 var imageNode = node;
-                if (!currentPage.openGraph) {
-                  currentPage.openGraph = {};
-                }
-                currentPage.openGraph.images = [{
+                currentPage.image = {
                   url: imageNode.url,
-                  width: 800,
-                  height: 600,
                   alt: imageNode.alt || currentPage.title || currentPage.slug || ''
-                }];
+                };
                 return;
               }
             }

package/esm/pipeline/transformMarkdownMetadata/transformMarkdownMetadata.js

@@ -305,8 +305,8 @@ function toPageMetadata(metadata, filePath) {
     descriptionMarkdown: (_options$visibleDescr2 = options.visibleDescriptionMarkdown) != null ? _options$visibleDescr2 : metadata.descriptionMarkdown,
     keywords: metadata.keywords,
     sections: metadata.sections,
-    openGraph: metadata.openGraph,
-    embeddings: metadata.embeddings
+    embeddings: metadata.embeddings,
+    image: metadata.image
   };
 }
 
@@ -720,26 +720,6 @@ export var transformMarkdownMetadata = function transformMarkdownMetadata() {
                 shouldUpdateMetadata = true;
               }
 
-              // Fill in openGraph title and description if missing
-              if (!mutableMetadata.openGraph) {
-                mutableMetadata.openGraph = {};
-              }
-              if (firstH1 && !mutableMetadata.openGraph.title) {
-                mutableMetadata.openGraph.title = firstH1;
-                shouldUpdateMetadata = true;
-              }
-
-              // Prioritize meta tag description over paragraph for openGraph
-              if (!mutableMetadata.openGraph.description) {
-                if (metaDescription) {
-                  mutableMetadata.openGraph.description = metaDescription;
-                  shouldUpdateMetadata = true;
-                } else if (firstParagraphAfterH1) {
-                  mutableMetadata.openGraph.description = firstParagraphAfterH1;
-                  shouldUpdateMetadata = true;
-                }
-              }
-
               // Add sections hierarchy if we have headings
               hasSections = mutableMetadata.sections && Object.keys(mutableMetadata.sections).length > 0;
               if (headings.length > 1 && !hasSections) {
@@ -768,11 +748,7 @@ export var transformMarkdownMetadata = function transformMarkdownMetadata() {
                 description: descriptionValue,
                 descriptionMarkdown: descriptionMarkdownValue,
                 keywords: metaKeywords || undefined,
-                sections: headings.length > 1 ? buildHeadingHierarchy(headings) : undefined,
-                openGraph: {
-                  title: firstH1 || undefined,
-                  description: descriptionValue
-                }
+                sections: headings.length > 1 ? buildHeadingHierarchy(headings) : undefined
               };
 
               // Create a new metadata export and add it to the tree
@@ -863,7 +839,7 @@ export var transformMarkdownMetadata = function transformMarkdownMetadata() {
                     exports: page.exports,
                     tags: page.tags,
                     skipDetailSection: page.skipDetailSection,
-                    openGraph: page.openGraph
+                    image: page.image
                   };
                 })
               }; // Find and update the wrapper component in the AST

package/esm/pipeline/transformMarkdownMetadata/types.d.ts

@@ -97,14 +97,8 @@ export interface ExtractedMetadata {
   keywords?: string[];
   sections?: HeadingHierarchy;
   embeddings?: number[];
-  openGraph?: {
-    title?: string;
-    description?: string;
-    images?: Array<{
-      url: string;
-      width: number;
-      height: number;
-      alt: string;
-    }>;
+  image?: {
+    url: string;
+    alt?: string;
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/internal-docs-infra",
-  "version": "0.3.1-canary.1",
+  "version": "0.3.1-canary.2",
   "author": "MUI Team",
   "description": "MUI Infra - internal documentation creation tools.",
   "bin": {
@@ -329,5 +329,5 @@
     },
     "./esm": null
   },
-  "gitSha": "04aa71c45b922602c25a926df3a7e17cb3744ac1"
+  "gitSha": "1ff097fa93dd7975b1282196feadba23916b2347"
 }