mintlify 1.1.12 → 1.3.0

package/bin/mint/client/next-env.d.ts

@@ -1,4 +0,0 @@
-/// <reference types="next" />
-
-// NOTE: This file should not be edited
-// see https://nextjs.org/docs/basic-features/typescript for more information.

package/bin/mint/client/next.config.js

@@ -1,152 +0,0 @@
-import { withSentryConfig } from '@sentry/nextjs';
-import withLinkRoles from './rehype/withLinkRoles.js';
-import { createLoader } from 'simple-functional-loader';
-import frontMatter from 'front-matter';
-import withSmartypants from 'remark-smartypants';
-import withTableOfContents from './remark/withTableOfContents.js';
-import withCodeBlocks from './rehype/withCodeBlocks.js';
-import withNextLinks from './remark/withNextLinks.js';
-import withFrames from './remark/withFrames.js';
-import withImportsInjected from './remark/withImportsInjected.js';
-import BundleAnalyzer from '@next/bundle-analyzer';
-import remarkGfm from 'remark-gfm';
-import withStaticProps from './rehype/withStaticProps.js';
-import withApiComponents from './rehype/withApiComponents.js';
-import withRawComponents from './rehype/withRawComponents.js';
-import mintConfig from './src/mint.json' assert { type: 'json' };
-import withSyntaxHighlighting from './rehype/withSyntaxHighlighting.js';
-import withLayouts from './rehype/withLayouts.js';
-import { potentiallyRemoveEndMatter } from './prebuild/injectNav.js';
-
-const withBundleAnalyzer = BundleAnalyzer({
-  enabled: process.env.ANALYZE === 'true',
-});
-
-const sentryWebpackPluginOptions = {
-  // Suppresses all logs
-  silent: true,
-
-  // Disable sentry builds when we don't have a sentry auth token.
-  // Sites have to be manually added to our Sentry tracking so by default
-  // new customers' sites will not have an auth token set.
-  dryRun: process.env.VERCEL_ENV !== 'production' || !process.env.SENTRY_AUTH_TOKEN,
-};
-
-export default withSentryConfig(
-  withBundleAnalyzer({
-    swcMinify: true,
-    pageExtensions: ['js', 'jsx', 'mdx', 'ts', 'tsx', 'md'],
-    images: {
-      disableStaticImages: true,
-    },
-    basePath: mintConfig?.basePath,
-    webpack(config, options) {
-      config.module.rules.push({
-        test: /\.(png|jpe?g|gif|webp|avif|mp4)$/i,
-        issuer: /\.(jsx?|tsx?|mdx?)$/,
-        use: [
-          {
-            loader: 'file-loader',
-            options: {
-              publicPath: '/_next',
-              name: 'static/media/[name].[hash].[ext]',
-            },
-          },
-        ],
-      });
-
-      config.module.rules.push({
-        test: /\.svg$/,
-        use: [
-          {
-            loader: '@svgr/webpack',
-            options: { svgoConfig: { plugins: { removeViewBox: false } } },
-          },
-          {
-            loader: 'file-loader',
-            options: {
-              publicPath: '/_next',
-              name: 'static/media/[name].[hash].[ext]',
-            },
-          },
-        ],
-      });
-
-      config.module.rules.push({
-        test: { and: [/\.mdx$/, /snippets/] },
-        use: [
-          options.defaultLoaders.babel,
-          {
-            loader: '@mdx-js/loader',
-            options: {
-              providerImportSource: '@mdx-js/react',
-              remarkPlugins: [
-                remarkGfm,
-                withImportsInjected,
-                withFrames,
-                withNextLinks,
-                withSmartypants,
-              ],
-              rehypePlugins: [
-                [
-                  withSyntaxHighlighting,
-                  {
-                    ignoreMissing: true,
-                  },
-                ],
-                withCodeBlocks,
-                withLinkRoles,
-              ],
-            },
-          },
-        ],
-      });
-
-      config.module.rules.push({
-        test: { and: [/\.mdx?$/], not: [/snippets/] },
-        use: [
-          options.defaultLoaders.babel,
-          {
-            loader: '@mdx-js/loader',
-            options: {
-              providerImportSource: '@mdx-js/react',
-              remarkPlugins: [
-                remarkGfm,
-                withImportsInjected,
-                withFrames,
-                withTableOfContents,
-                withNextLinks,
-                withSmartypants,
-              ],
-              rehypePlugins: [
-                [
-                  withSyntaxHighlighting,
-                  {
-                    ignoreMissing: true,
-                  },
-                ],
-                withCodeBlocks,
-                withLinkRoles,
-                withApiComponents,
-                withRawComponents,
-                [
-                  withStaticProps,
-                  `{
-                    isMdx: true
-                  }`,
-                ],
-                withLayouts
-              ],
-            },
-          },
-          createLoader(function (source) {
-            const { body } = frontMatter(source);
-            return potentiallyRemoveEndMatter(body);
-          }),
-        ],
-      });
-      return config;
-    },
-  }),
-  sentryWebpackPluginOptions
-);

package/bin/mint/client/package.json

@@ -1,139 +0,0 @@
-{
-  "private": true,
-  "type": "module",
-  "scripts": {
-    "prebuild": "node prebuild index.ts",
-    "local": "node scripts/local",
-    "dev": "next dev",
-    "build": "next build",
-    "start": "next start",
-    "export": "next build && next export",
-    "format": "prettier '{src,remark,scripts}/**/*.{css,js,mdx}' --write",
-    "test": "jest"
-  },
-  "browserslist": [
-    "> 1%"
-  ],
-  "dependencies": {
-    "@amplitude/analytics-browser": "^1.2.0",
-    "@babel/plugin-transform-react-jsx": "^7.14.9",
-    "@babel/preset-env": "^7.1.6",
-    "@badrap/bar-of-progress": "^0.1.1",
-    "@fortawesome/fontawesome-svg-core": "^6.1.2",
-    "@fortawesome/free-brands-svg-icons": "^6.1.2",
-    "@fortawesome/pro-duotone-svg-icons": "^6.1.2",
-    "@fortawesome/pro-light-svg-icons": "^6.1.2",
-    "@fortawesome/pro-regular-svg-icons": "^6.1.2",
-    "@fortawesome/pro-solid-svg-icons": "^6.1.2",
-    "@fortawesome/pro-thin-svg-icons": "^6.1.2",
-    "@fortawesome/react-fontawesome": "^0.2.0",
-    "@headlessui/react": "^1.6.6",
-    "@heroicons/react": "^1.0.6",
-    "@juggle/resize-observer": "^3.2.0",
-    "@mdx-js/loader": "^2.1.3",
-    "@mdx-js/react": "^2.1.3",
-    "@mintlify/components": "^0.1.23",
-    "@next/bundle-analyzer": "^12.3.1",
-    "@next/mdx": "^12.3.0",
-    "@sentry/nextjs": "^7.9.0",
-    "@sindresorhus/slugify": "^1.1.0",
-    "@svgr/webpack": "^6.3.1",
-    "@tailwindcss/aspect-ratio": "^0.4.2",
-    "@tailwindcss/line-clamp": "^0.3.1",
-    "@tailwindcss/typography": "^0.5.0",
-    "acorn": "8.8.0",
-    "algoliasearch": "^4.14.0",
-    "autoprefixer": "^10.4.0",
-    "axios": "^0.27.2",
-    "babel-plugin-macros": "^3.1.0",
-    "brotli-size": "^4.0.0",
-    "clean-css": "^4.2.3",
-    "clsx": "^1.1.1",
-    "deasync": "^0.1.20",
-    "debounce": "^1.2.0",
-    "dlv": "^1.1.3",
-    "exec-sh": "^0.3.4",
-    "fathom-client": "^3.5.0",
-    "feed": "^4.2.2",
-    "file-loader": "^6.0.0",
-    "focus-visible": "^5.1.0",
-    "front-matter": "^4.0.2",
-    "fs-extra": "^10.1.0",
-    "github-url-to-object": "^4.0.6",
-    "glob": "^7.1.6",
-    "gsap": "^3.6.0",
-    "gzip-size": "^5.1.1",
-    "hast-util-from-html": "^1.0.0",
-    "hast-util-to-html": "^8.0.3",
-    "html-react-parser": "^3.0.4",
-    "intersection-observer": "^0.11.0",
-    "is-absolute-url": "^4.0.1",
-    "just-group-by": "^1.0.0",
-    "mdast-util-from-markdown": "^1.2.0",
-    "mdast-util-mdx-jsx": "^2.1.0",
-    "mdast-util-mdxjs-esm": "^1.3.0",
-    "micromark-extension-mdx-jsx": "^1.0.3",
-    "mini-svg-data-uri": "^1.4.3",
-    "minimatch": "^3.0.4",
-    "mixpanel-browser": "^2.45.0",
-    "next": "^12.2.5",
-    "openapi-types": "^12.0.0",
-    "postcss": "^8.4.5",
-    "postcss-focus-visible": "^5.0.0",
-    "postcss-import": "^14.0.1",
-    "posthog-js": "^1.29.3",
-    "prismjs": "^1.27.0",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "react-hotjar": "^5.1.0",
-    "react-hotkeys-hook": "^3.4.7",
-    "react-intersection-observer": "^8.29.0",
-    "react-use-rect": "^2.0.4",
-    "redent": "^3.0.0",
-    "remark-gfm": "^3.0.1",
-    "remark-smartypants": "^2.0.0",
-    "seedrandom": "^3.0.5",
-    "simple-functional-loader": "^1.2.1",
-    "stringify-object": "^3.3.0",
-    "tailwindcss": "^3.1.6",
-    "tinytime": "^0.2.6",
-    "webpack": "^5.74.0",
-    "zustand": "^4.0.0-rc.0"
-  },
-  "devDependencies": {
-    "@apidevtools/swagger-parser": "^10.1.0",
-    "@babel/core": "^7.0.0-0",
-    "@babel/plugin-syntax-flow": "^7.14.5",
-    "@next/eslint-plugin-next": "^12.3.0",
-    "@trivago/prettier-plugin-sort-imports": "^3.3.0",
-    "@types/github-url-to-object": "^4.0.1",
-    "@types/glob": "^7.2.0",
-    "@types/jest": "^29.1.2",
-    "@types/mdx-js__react": "^1.5.5",
-    "@types/node": "^18.0.5",
-    "@types/prismjs": "^1.26.0",
-    "@types/react": "18.0.1",
-    "@types/react-dom": "^18.0.6",
-    "@types/seedrandom": "^3.0.2",
-    "@typescript-eslint/eslint-plugin": "^5.35.1",
-    "@typescript-eslint/parser": "^5.35.1",
-    "babel-eslint": "10.x",
-    "eslint": "^8.22.0",
-    "eslint-config-react-app": "^7.0.1",
-    "eslint-plugin-flowtype": "4.x",
-    "eslint-plugin-import": "2.x",
-    "eslint-plugin-jsx-a11y": "6.x",
-    "eslint-plugin-react": "7.x",
-    "eslint-plugin-react-hooks": "^4.6.0",
-    "favicons": "7.0.0-beta.4",
-    "gray-matter": "^4.0.3",
-    "hast-util-to-string": "^2.0.0",
-    "jest": "^29.1.2",
-    "prettier": "^2.5.0",
-    "refractor": "^4.8.0",
-    "ts-node": "^10.9.1",
-    "typescript": "^4.7.4",
-    "unist-util-filter": "^4.0.0",
-    "unist-util-visit": "^2.0.3"
-  }
-}

package/bin/mint/client/postcss.config.cjs

@@ -1,9 +0,0 @@
-module.exports = {
-  plugins: [
-    'postcss-import',
-    'tailwindcss/nesting',
-    'tailwindcss',
-    'postcss-focus-visible',
-    'autoprefixer',
-  ],
-}

package/bin/mint/client/prebuild/faviconConfig.js

@@ -1,35 +0,0 @@
-const faviconConfig = (name) => ({
-  path: '/favicons', // Path for overriding default icons path. `string`
-  appName: name, // Your application's name. `string`
-  appShortName: name, // Your application's short_name. `string`. Optional. If not set, appName will be used
-  appDescription: null, // Your application's description. `string`
-  developerName: null, // Your (or your developer's) name. `string`
-  developerURL: null, // Your (or your developer's) URL. `string`
-  dir: 'auto', // Primary text direction for name, short_name, and description
-  lang: 'en-US', // Primary language for name and short_name
-  background: '#fff', // Background colour for flattened icons. `string`
-  theme_color: '#fff', // Theme color user for example in Android's task switcher. `string`
-  appleStatusBarStyle: 'black-translucent', // Style for Apple status bar: "black-translucent", "default", "black". `string`
-  display: 'standalone', // Preferred display mode: "fullscreen", "standalone", "minimal-ui" or "browser". `string`
-  orientation: 'any', // Default orientation: "any", "natural", "portrait" or "landscape". `string`
-  scope: '/', // set of URLs that the browser considers within your app
-  start_url: '/?homescreen=1', // Start URL when launching the application from a device. `string`
-  preferRelatedApplications: false, // Should the browser prompt the user to install the native companion app. `boolean`
-  relatedApplications: undefined, // Information about the native companion apps. This will only be used if `preferRelatedApplications` is `true`. `Array<{ id: string, url: string, platform: string }>`
-  version: '1.0', // Your application's version string. `string`
-  logging: false, // Print logs to console? `boolean`
-  pixel_art: false, // Keeps pixels "sharp" when scaling up, for pixel art.  Only supported in offline mode.
-  loadManifestWithCredentials: true, // Browsers don't send cookies when fetching a manifest, enable this to fix that. `boolean`
-  manifestMaskable: false, // Maskable source image(s) for manifest.json. "true" to use default source. More information at https://web.dev/maskable-icon/. `boolean`, `string`, `buffer` or array of `string`
-  icons: {
-    android: ['android-chrome-192x192.png', 'android-chrome-256x256.png'],
-    appleIcon: ['apple-touch-icon.png'],
-    appleStartup: false,
-    favicons: true,
-    windows: ['mstile-150x150.png'],
-    yandex: false,
-    firefox: false,
-  },
-});
-
-export default faviconConfig;

package/bin/mint/client/prebuild/getOpenApiContext.js

@@ -1,53 +0,0 @@
-export const extractMethodAndEndpoint = (api) => {
-  const methodRegex = /^get|post|put|delete|patch/i;
-  const trimmed = api.trim();
-  const foundMethod = trimmed.match(methodRegex);
-
-  const endIndexOfMethod = foundMethod ? api.indexOf(foundMethod[0]) + foundMethod[0].length : 0;
-
-  return {
-    method: foundMethod ? foundMethod[0].toUpperCase() : undefined,
-    endpoint: api.substring(endIndexOfMethod).trim(),
-  };
-};
-
-export const getOpenApiOperationMethodAndEndpoint = (openApiObj, openApiMetaField) => {
-  const { endpoint, method } = extractMethodAndEndpoint(openApiMetaField);
-
-  const path = openApiObj?.paths && openApiObj.paths[endpoint];
-
-  if (path == null) {
-    return {};
-  }
-
-  let operation;
-  if (method) {
-    operation = path[method.toLowerCase()];
-  } else {
-    const firstOperationKey = Object.keys(path)[0];
-    operation = path[firstOperationKey];
-  }
-
-  return {
-    operation,
-    method,
-    endpoint,
-  };
-};
-
-export const getOpenApiTitleAndDescription = (openApiObj, openApiMetaField) => {
-  if (openApiObj == null || !openApiMetaField || openApiMetaField == null) {
-    return {};
-  }
-
-  const { operation } = getOpenApiOperationMethodAndEndpoint(openApiObj, openApiMetaField);
-
-  if (operation == null) {
-    return {};
-  }
-
-  return {
-    title: operation.summary,
-    description: operation.description,
-  };
-};

package/bin/mint/client/prebuild/index.js

@@ -1,117 +0,0 @@
-import axios from 'axios';
-import favicons from 'favicons';
-import fs from 'fs-extra';
-import { dirname } from 'path';
-import { resolve } from 'path';
-import { fileURLToPath } from 'url';
-
-import faviconConfig from './faviconConfig.js';
-import { createPage, injectNav } from './injectNav.js';
-
-const API_ENDPOINT = 'https://docs.mintlify.com';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-
-const injectMarkdownFilesAndNav = (markdownFiles, openApiObj, configObj) => {
-  let pages = {};
-  markdownFiles.forEach((markdownFile) => {
-    const path = __dirname + `/../src/pages/${markdownFile.path}`;
-    const page = createPage(markdownFile.path, markdownFile.content, openApiObj);
-    if (page != null) {
-      pages = {
-        ...pages,
-        ...page,
-      };
-    }
-
-    fs.outputFileSync(path, Buffer.from(markdownFile.content), { flag: 'w' });
-  });
-
-  console.log(`📄  ${markdownFiles.length} pages injected`);
-
-  injectNav(pages, configObj);
-};
-
-const injectStaticFiles = (staticFiles) => {
-  staticFiles.forEach((staticFile) => {
-    const path = __dirname + `/../public/${staticFile.path}`;
-    fs.outputFileSync(path, Buffer.from(staticFile.content), { flag: 'w' });
-  });
-
-  console.log(`📄  ${staticFiles.length} static files injected`);
-};
-
-const injectConfig = (config) => {
-  const path = __dirname + `/../src/mint.json`;
-  const buffer = Buffer.from(config);
-  fs.outputFileSync(path, buffer, { flag: 'w' });
-  console.log('⚙️  Config file set properly as mint.json');
-  return JSON.parse(buffer.toString());
-};
-
-const injectFavicons = async (config) => {
-  const buffer = Buffer.from(config);
-  const configJSON = JSON.parse(buffer.toString());
-
-  if (configJSON?.favicon == null) return;
-
-  const desiredPath = resolve(__dirname + `/../public/${configJSON.favicon}`);
-  const favicon = fs.readFileSync(desiredPath);
-  if (favicon == null) return;
-  console.log('Generating favicons...');
-  favicons(favicon, faviconConfig(config?.name), (err, response) => {
-    if (err) {
-      console.log(err.message); // Error description e.g. "An unknown error has occurred"
-      return;
-    }
-    response.images.forEach((img) => {
-      const path = __dirname + `/../public/favicons/${img.name}`;
-      fs.outputFileSync(path, Buffer.from(img.contents), { flag: 'w' });
-    });
-    response.files.forEach((file) => {
-      const path = __dirname + `/../public/favicons/${file.name}`;
-      fs.outputFileSync(path, file.contents, { flag: 'w' });
-    });
-    console.log('Favicons generated');
-  });
-};
-
-const injectOpenApi = async (openApi) => {
-  const path = __dirname + `/../src/openapi.json`;
-  if (openApi) {
-    const buffer = Buffer.from(openApi);
-    fs.outputFileSync(path, buffer, { flag: 'w' });
-    console.log('🖥️  OpenAPI file detected and set as openapi.json');
-    return JSON.parse(buffer.toString());
-  }
-
-  fs.outputFileSync(path, '{}', { flag: 'w' });
-};
-
-const getAllFilesAndConfig = async () => {
-  const ref = process.env.GIT_REF;
-  const {
-    data: { markdownFiles, staticFiles, config, openApi },
-  } = await axios.get(`${API_ENDPOINT}/api/v1/sites/files`, {
-    headers: { Authorization: `Bearer ${process.env.INTERNAL_SITE_BEARER_TOKEN}` },
-    params: {
-      ref,
-    },
-  });
-  const openApiObj = await injectOpenApi(openApi);
-  const configObj = await injectConfig(config);
-  injectMarkdownFilesAndNav(markdownFiles, openApiObj, configObj);
-  injectStaticFiles(staticFiles);
-  injectFavicons(config);
-};
-
-(async function () {
-  try {
-    console.log('🔍  Fetching files');
-    await getAllFilesAndConfig();
-  } catch (error) {
-    console.log(error);
-    console.error('⚠️   Error while prebuilding documents');
-  }
-})();

package/bin/mint/client/prebuild/injectNav.js

@@ -1,115 +0,0 @@
-import fs from 'fs-extra';
-import matter from 'gray-matter';
-import { dirname } from 'path';
-import { fileURLToPath } from 'url';
-
-import { getOpenApiTitleAndDescription } from './getOpenApiContext.js';
-import { slugToTitle } from './slugToTitle.js';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-
-// End matter is front matter, but at the end
-const getIndexOfEndMatter = (fileContents) => {
-  const frontMatters = fileContents.match(
-    /---\n(title:.+\n|description:.+\n|sidebarTitle:.+\n|api:.+\n|openapi:.+\n)+---$/m
-  );
-  if (frontMatters) {
-    return fileContents.indexOf(frontMatters[0]);
-  }
-
-  return -1;
-};
-
-export const potentiallyRemoveEndMatter = (fileContents) => {
-  const endMatterIndex = getIndexOfEndMatter(fileContents);
-
-  if (endMatterIndex === -1) {
-    return fileContents;
-  }
-
-  return fileContents.substring(0, endMatterIndex);
-};
-
-const getMetadata = (fileContents) => {
-  const { data } = matter(fileContents);
-
-  if (Object.keys(data).length > 0) {
-    return data;
-  }
-
-  const startIndex = getIndexOfEndMatter(fileContents);
-  if (startIndex === -1) {
-    return {};
-  }
-
-  const fileContentFromFrontMatter = fileContents.substring(startIndex);
-  const { data: nonTopFrontMatter } = matter(fileContentFromFrontMatter);
-  return nonTopFrontMatter;
-};
-
-export const createPage = (path, content, openApiObj) => {
-  const slug = path.replace(/\.mdx?$/, '');
-  let defaultTitle = slugToTitle(slug);
-  const fileContents = Buffer.from(content).toString();
-  const metadata = getMetadata(fileContents);
-  // Append data from OpenAPI if it exists
-  const { title, description } = getOpenApiTitleAndDescription(openApiObj, metadata?.openapi);
-  if (title) {
-    defaultTitle = title;
-  }
-  return {
-    [slug]: { title: defaultTitle, description, ...metadata, href: `/${slug}` },
-  };
-};
-
-export const injectNav = (pages, configObj) => {
-  const path = __dirname + `/../src/metadata.json`;
-  const createNav = (nav) => {
-    return {
-      group: nav.group,
-      pages: nav.pages.map((page) => {
-        if (typeof page === 'string') {
-          return pages[page];
-        }
-
-        return createNav(page);
-      }),
-    };
-  };
-
-  if (configObj?.navigation == null) {
-    return;
-  }
-
-  let navFile = configObj.navigation.map((nav) => createNav(nav));
-  const filterOutNullInPages = (pages) => {
-    const newPages = [];
-    pages.forEach((page) => {
-      if (page == null) {
-        return;
-      }
-      if (page?.pages) {
-        const newGroup = filterOutNullInGroup(page);
-        newPages.push(newGroup);
-      } else {
-        newPages.push(page);
-      }
-    });
-
-    return newPages;
-  };
-  const filterOutNullInGroup = (group) => {
-    const newPages = filterOutNullInPages(group.pages);
-    const newGroup = {
-      ...group,
-      pages: newPages,
-    };
-    return newGroup;
-  };
-  const newNavFile = navFile.map((group) => {
-    return filterOutNullInGroup(group);
-  });
-  fs.outputFileSync(path, JSON.stringify(newNavFile, null, 2), { flag: 'w' });
-  console.log(`⛵️ Navigation generated and injected`);
-};

package/bin/mint/client/prebuild/slugToTitle.js

@@ -1,7 +0,0 @@
-export const slugToTitle = (slug) => {
-  const slugArr = slug.split('/');
-  let defaultTitle = slugArr[slugArr.length - 1].split('-').join(' '); //replace all dashes
-  defaultTitle = defaultTitle.split('_').join(' '); //replace all underscores
-  defaultTitle = defaultTitle.charAt(0).toUpperCase() + defaultTitle.slice(1); //capitalize first letter
-  return defaultTitle;
-};