@mintlify/common 1.0.1020 → 1.0.1021

package/dist/mdx/getMDXOptions.js

@@ -1,4 +1,4 @@
-import { rehypeCodeBlocks, rehypeDynamicTailwindCss, rehypeKeyboardSymbols, rehypeListItemText, rehypeMdxExtractEndpoint, rehypeMdxExtractExamples, rehypeParamFieldIds, rehypeRawComponents, rehypeTable, rehypeUnicodeIds, rehypeZoomImages, remarkExtractChangelogFilters, remarkExtractTableOfContents, remarkFileTree, remarkFrames, remarkComponentIds, remarkMdxInjectSnippets, remarkMdxRemoveUnusedVariables, remarkRemoveImports, remarkMdxExtractPanel, remarkResolveRelativeLinks, remarkVideo, remarkMdxClientComponentBoundaries, remarkExtractMultiView, remarkPrompt, remarkUnwrapJsxHeadings, } from './plugins/index.js';
+import { rehypeCodeBlocks, rehypeDynamicTailwindCss, rehypeKeyboardSymbols, rehypeListItemText, rehypeMdxExtractEndpoint, rehypeMdxExtractExamples, rehypeParamFieldIds, rehypeRawComponents, rehypeTable, rehypeUnicodeIds, rehypeZoomImages, remarkExtractChangelogFilters, remarkExtractTableOfContents, remarkFileTree, remarkFrames, remarkComponentIds, remarkMdxInjectSnippets, remarkMdxRemoveUnusedVariables, remarkRemoveImports, remarkMdxExtractPanel, remarkResolveRelativeLinks, remarkVideo, remarkMdxClientComponentBoundaries, remarkExtractMultiView, remarkPrompt, remarkUnwrapInlineJsx, remarkUnwrapJsxHeadings, } from './plugins/index.js';
 import { remarkMdxRemoveUnknownJsx } from './plugins/remark/remarkMdxRemoveUnknownJsx/index.js';
 import { remarkMermaid } from './plugins/remark/remarkMermaid.js';
 // avoid running extractors unnecessarily
@@ -18,6 +18,7 @@ export const getMDXOptions = ({ data, remarkPlugins = [], rehypePlugins = [], md
             remarkPrompt,
             [remarkComponentIds, data.pageMetadata],
             remarkUnwrapJsxHeadings,
+            remarkUnwrapInlineJsx,
             [remarkExtractTableOfContents, mdxExtracts, data.pageMetadata], // modifies tree so cannot be excluded
             [remarkExtractChangelogFilters, mdxExtracts],
             [remarkMdxExtractPanel, mdxExtracts],

package/dist/mdx/plugins/remark/index.d.ts

@@ -20,5 +20,6 @@ export * from './remarkVideo.js';
 export * from './remarkExtractMultiView.js';
 export * from './remarkPrompt.js';
 export * from './remarkResolveRelativeLinks.js';
+export * from './remarkUnwrapInlineJsx.js';
 export * from './remarkUnwrapJsxHeadings.js';
 export * from './remarkVisibilityForMarkdown.js';

package/dist/mdx/plugins/remark/index.js

@@ -20,5 +20,6 @@ export * from './remarkVideo.js';
 export * from './remarkExtractMultiView.js';
 export * from './remarkPrompt.js';
 export * from './remarkResolveRelativeLinks.js';
+export * from './remarkUnwrapInlineJsx.js';
 export * from './remarkUnwrapJsxHeadings.js';
 export * from './remarkVisibilityForMarkdown.js';

package/dist/mdx/plugins/remark/remarkPrompt.js

@@ -12,7 +12,7 @@ const dedent = (text) => {
 export const remarkPrompt = () => {
     return (tree, file) => {
         const source = String(file.value);
-        visit(tree, 'mdxJsxFlowElement', (node) => {
+        const transformPromptNode = (node) => {
             if (node.name !== 'Prompt')
                 return;
             if (!node.position)
@@ -23,7 +23,7 @@ export const remarkPrompt = () => {
             const endOffset = node.position.end.offset;
             if (startOffset === undefined || endOffset === undefined)
                 return;
-            const nodeSource = source.slice(startOffset, endOffset);
+            const nodeSource = source.slice(startOffset, endOffset).replace(/\r\n?/g, '\n');
             let inString = false;
             let braceDepth = 0;
             let openTagEnd = -1;
@@ -34,7 +34,7 @@ export const remarkPrompt = () => {
                         inString = false;
                     continue;
                 }
-                if (ch === '"' || ch === "'") {
+                if (ch === '"' || ch === "'" || ch === '`') {
                     inString = ch;
                     continue;
                 }
@@ -84,6 +84,8 @@ export const remarkPrompt = () => {
                 },
             });
             node.children = [];
-        });
+        };
+        visit(tree, 'mdxJsxFlowElement', transformPromptNode);
+        visit(tree, 'mdxJsxTextElement', transformPromptNode);
     };
 };

package/dist/mdx/plugins/remark/remarkUnwrapInlineJsx.d.ts

@@ -0,0 +1,11 @@
+import type { Root } from 'mdast';
+/**
+ * Unwraps the paragraph MDX generates around the content of inline components
+ * authored in block form (`<Badge>\nBeta\n</Badge>`). Without this, the
+ * paragraph renders inside the component's inline element (`<span><p>`,
+ * `<button><p>`) — invalid HTML that browsers reparse, causing hydration
+ * mismatches. Any other block content (multiple paragraphs, headings,
+ * blockquotes, ...) is left untouched (flattening would silently merge
+ * blocks) and surfaced with a warning instead.
+ */
+export declare const remarkUnwrapInlineJsx: () => (tree: Root) => void;

package/dist/mdx/plugins/remark/remarkUnwrapInlineJsx.js

@@ -0,0 +1,26 @@
+import { visit } from 'unist-util-visit';
+const INLINE_JSX_COMPONENTS = new Set(['Badge', 'Tooltip']);
+/**
+ * Unwraps the paragraph MDX generates around the content of inline components
+ * authored in block form (`<Badge>\nBeta\n</Badge>`). Without this, the
+ * paragraph renders inside the component's inline element (`<span><p>`,
+ * `<button><p>`) — invalid HTML that browsers reparse, causing hydration
+ * mismatches. Any other block content (multiple paragraphs, headings,
+ * blockquotes, ...) is left untouched (flattening would silently merge
+ * blocks) and surfaced with a warning instead.
+ */
+export const remarkUnwrapInlineJsx = () => (tree) => {
+    visit(tree, 'mdxJsxFlowElement', (node) => {
+        if (!node.name || !INLINE_JSX_COMPONENTS.has(node.name))
+            return;
+        const [onlyChild] = node.children;
+        if (node.children.length === 1 && (onlyChild === null || onlyChild === void 0 ? void 0 : onlyChild.type) === 'paragraph') {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any -- phrasing content is valid at runtime; mdast types only allow block content here
+            node.children = onlyChild.children;
+            return;
+        }
+        if (node.children.length > 0) {
+            console.warn(`<${node.name}> is an inline component; block-level content inside it renders invalid HTML. Use a single line of content.`);
+        }
+    });
+};