mintlify 1.1.1 → 1.1.2

package/bin/mint/client/rehype/withApiComponents.js

@@ -0,0 +1,60 @@
+import { toHtml } from 'hast-util-to-html';
+import { filter } from 'unist-util-filter';
+import visit from 'unist-util-visit';
+
+import { addExport } from '../remark/utils.js';
+
+const langFilename = (className) => {
+  switch (className) {
+    case 'language-shell':
+      return 'Bash';
+    case 'language-json':
+      return 'JSON';
+    case 'language-js':
+      return 'JavaScript';
+    default:
+      const language = className.substring(9);
+      return language.charAt(0).toUpperCase() + language.slice(1);
+  }
+};
+const withApiComponents = () => {
+  return (tree) => {
+    let apiComponents = [];
+    visit(tree, 'mdxJsxFlowElement', (node, _, parent) => {
+      if (['ResponseExample', 'RequestExample'].includes(node.name)) {
+        // remove all jsx components to convert to html (removes <ResponseExample> and <Editor>)
+        const children = node.children.map((child, i) => {
+          const preComponent = child.children[0];
+          const html = toHtml(preComponent);
+          let filename =
+            preComponent?.properties?.className?.length > 1
+              ? langFilename(preComponent?.properties?.className[0])
+              : '';
+          if (child?.attributes && child.attributes.length > 0) {
+            filename = child.attributes[0]?.value;
+          }
+          return {
+            filename,
+            html,
+          };
+        });
+        apiComponents.push({
+          type: node.name,
+          children,
+        });
+      }
+
+      if (parent.type === 'root' && (node.name === 'Param' || node.name === 'ParamField')) {
+        apiComponents.push({
+          type: 'ParamField',
+          children: node.children,
+          attributes: node.attributes,
+        });
+      }
+    });
+    addExport(tree, 'apiComponents', apiComponents);
+    return filter(tree, (node) => !['ResponseExample', 'RequestExample'].includes(node.name));
+  };
+};
+
+export default withApiComponents;

package/bin/mint/client/rehype/withCodeBlocks.js

@@ -0,0 +1,54 @@
+import { fromHtml } from 'hast-util-from-html';
+import visit from 'unist-util-visit';
+
+import { addImport } from '../remark/utils.js';
+
+const withCodeBlocks = () => {
+  return (tree) => {
+    let preTree = { children: [] };
+    let componentName;
+
+    visit(tree, 'element', (node, i, parent) => {
+      if (node?.tagName !== 'pre') return node;
+      if (node?.children && node?.children[0]?.tagName !== 'code') return node;
+      const code = node.children[0];
+      const copyToClipboard = fromHtml(
+        `<span class="copy-to-clipboard w-5 z-10 flex absolute right-5"><svg class="top-5 h-5 fill-slate-500 hover:fill-slate-300 cursor-pointer" viewBox="0 0 20 20"><path d="M8 3a1 1 0 011-1h2a1 1 0 110 2H9a1 1 0 01-1-1z" /><path d="M6 3a2 2 0 00-2 2v11a2 2 0 002 2h8a2 2 0 002-2V5a2 2 0 00-2-2 3 3 0 01-3 3H9a3 3 0 01-3-3z" /></svg><div class="tooltip hidden absolute bottom-full left-1/2 mb-3.5 pb-1 -translate-x-1/2"><div class="relative bg-primary-dark text-white text-xs leading-6 font-medium px-1.5 rounded-lg" data-reach-alert="true"><span>Copied</span><svg aria-hidden="true" width="16" height="6" viewBox="0 0 16 6" class="text-primary-dark absolute top-full left-1/2 -mt-px -ml-2"><path fillRule="evenodd" clipRule="evenodd" d="M15 0H1V1.00366V1.00366V1.00371H1.01672C2.72058 1.0147 4.24225 2.74704 5.42685 4.72928C6.42941 6.40691 9.57154 6.4069 10.5741 4.72926C11.7587 2.74703 13.2803 1.0147 14.9841 1.00371H15V0Z" fill="currentColor"></path></svg></div></div></span>`,
+        { fragment: true }
+      );
+
+      const prepend = (value, array) => {
+        var newArray = array.slice();
+        newArray.unshift(value);
+        return newArray;
+      };
+      node.children = prepend(copyToClipboard, node.children);
+      let filename = undefined;
+      if (['RequestExample', 'ResponseExample'].includes(parent.name)) {
+        const parentType = parent.name.slice(0, -7);
+        filename = i === 0 ? parentType : `${parentType} ${i + 1}`;
+        node.children[0].data.meta = filename;
+      }
+
+      if (code.data?.meta) {
+        filename = code.data.meta;
+      }
+      if (filename) {
+        if (!componentName) {
+          componentName = addImport(preTree, '@/components/Editor', 'Editor');
+        }
+        const wrap = {
+          type: 'mdxJsxFlowElement',
+          name: componentName,
+          attributes: [{ type: 'mdxJsxAttribute', name: 'filename', value: filename }],
+          data: { _mdxExplicitJsx: true },
+        };
+        wrap.children = [node];
+        parent.children[i] = wrap;
+      }
+    });
+    tree.children = [...preTree.children, ...tree.children];
+  };
+};
+
+export default withCodeBlocks;

package/bin/mint/client/rehype/withLayouts.js

@@ -0,0 +1,113 @@
+import { getEsmNode } from '../remark/utils.js';
+
+const withLayouts = () => {
+  return (tree) => {
+    const importNode = getEsmNode(
+      `import { ContentsLayout as _Default } from '@/layouts/ContentsLayout'`
+    );
+    tree.children.unshift(importNode);
+    tree.children.push({
+      type: 'mdxjsEsm',
+      value: `export default (props) => <_Default {...props} tableOfContents={tableOfContents} apiComponents={apiComponents}>{props.children}</_Default>`,
+      data: {
+        estree: {
+          type: 'Program',
+          sourceType: 'module',
+          body: [
+            {
+              type: 'ExportDefaultDeclaration',
+              declaration: {
+                type: 'ArrowFunctionExpression',
+                async: false,
+                expression: true,
+                generator: false,
+                id: null,
+                body: {
+                  type: 'JSXElement',
+                  children: [
+                    {
+                      type: 'JSXExpressionContainer',
+                      expression: {
+                        type: 'MemberExpression',
+                        computed: false,
+                        optional: false,
+                        object: {
+                          name: 'props',
+                          type: 'Identifier',
+                        },
+                        property: {
+                          name: 'children',
+                          type: 'Identifier',
+                        },
+                      },
+                    },
+                  ],
+                  closingElement: {
+                    type: 'JSXClosingElement',
+                    name: {
+                      type: 'JSXIdentifier',
+                      name: '_Default',
+                    },
+                  },
+                  openingElement: {
+                    type: 'JSXOpeningElement',
+                    selfClosing: false,
+                    name: {
+                      type: 'JSXIdentifier',
+                      name: '_Default',
+                    },
+                    attributes: [
+                      {
+                        type: 'JSXSpreadAttribute',
+                        argument: {
+                          type: 'Identifier',
+                          name: 'props',
+                        },
+                      },
+                      {
+                        type: 'JSXAttribute',
+                        name: {
+                          type: 'JSXIdentifier',
+                          name: 'tableOfContents',
+                        },
+                        value: {
+                          type: 'JSXExpressionContainer',
+                          expression: {
+                            type: 'Identifier',
+                            name: 'tableOfContents',
+                          },
+                        },
+                      },
+                      {
+                        type: 'JSXAttribute',
+                        name: {
+                          type: 'JSXIdentifier',
+                          name: 'apiComponents',
+                        },
+                        value: {
+                          type: 'JSXExpressionContainer',
+                          expression: {
+                            type: 'Identifier',
+                            name: 'apiComponents',
+                          },
+                        },
+                      },
+                    ],
+                  },
+                },
+                params: [
+                  {
+                    type: 'Identifier',
+                    name: 'props',
+                  },
+                ],
+              },
+            },
+          ],
+        },
+      },
+    });
+  };
+};
+
+export default withLayouts;

package/bin/mint/client/rehype/withLinkRoles.js

@@ -0,0 +1,13 @@
+import visit from 'unist-util-visit';
+
+const withLinkRoles = () => {
+  return (tree) => {
+    visit(tree, 'element', (element) => {
+      if (['ol', 'ul'].includes(element.tagName)) {
+        element.properties.role = 'list';
+      }
+    });
+  };
+};
+
+export default withLinkRoles;

package/bin/mint/client/rehype/withRawComponents.js

@@ -0,0 +1,13 @@
+import { fromHtml } from 'hast-util-from-html';
+import visit from 'unist-util-visit';
+
+const withRawComponents = () => {
+  return (tree) => {
+    visit(tree, 'raw', (raw, i, parent) => {
+      const rawAst = fromHtml(raw.value, { fragment: true });
+      parent.children[i] = rawAst;
+    });
+  };
+};
+
+export default withRawComponents;

package/bin/mint/client/rehype/withStaticProps.js

@@ -0,0 +1,25 @@
+import { parse } from 'acorn';
+
+const withStaticProps = (map) => {
+  return function transformer(tree) {
+    tree.children.push({
+      type: 'mdxjsEsm',
+      data: {
+        estree: parse(
+          `
+          export const getStaticProps = async () => {
+            return {
+              props: ${map},
+            }
+          }`,
+          {
+            sourceType: 'module',
+            ecmaVersion: 2020,
+          }
+        ),
+      },
+    });
+  };
+};
+
+export default withStaticProps;

package/bin/mint/client/rehype/withSyntaxHighlighting.js

@@ -0,0 +1,60 @@
+import { toString } from 'hast-util-to-string';
+import { refractor } from 'refractor';
+import docker from 'refractor/lang/docker.js';
+import jsx from 'refractor/lang/jsx.js';
+import protobuf from 'refractor/lang/protobuf.js';
+import visit from 'unist-util-visit';
+
+refractor.register(jsx);
+refractor.register(docker);
+refractor.register(protobuf);
+
+const withSyntaxHighlighting = (options) => {
+  options = options || {};
+
+  if (options.alias) {
+    refractor.alias(options.alias);
+  }
+
+  return (tree) => {
+    visit(tree, 'element', visitor);
+  };
+
+  function visitor(node, _, parent) {
+    if (!parent || parent.tagName !== 'pre' || node.tagName !== 'code') {
+      return;
+    }
+
+    const lang = getLanguage(node);
+
+    if (lang === null) {
+      return;
+    }
+
+    let result;
+    try {
+      parent.properties.className = (parent.properties.className || []).concat('language-' + lang);
+      result = refractor.highlight(toString(node), lang);
+      node.children = result.children;
+    } catch (err) {
+      if (options.ignoreMissing && /Unknown language/.test(err.message)) {
+        return;
+      }
+      throw err;
+    }
+  }
+};
+
+function getLanguage(node) {
+  const className = node.properties.className || [];
+
+  for (const classListItem of className) {
+    if (classListItem.slice(0, 9) === 'language-') {
+      return classListItem.slice(9).toLowerCase();
+    }
+  }
+
+  return null;
+}
+
+export default withSyntaxHighlighting;