@mintlify/prebuild 1.0.1441 → 1.0.1442

package/dist/generate-docs-config.d.ts

@@ -0,0 +1,21 @@
+type NavGroup = {
+    group: string;
+    pages: (string | NavGroup)[];
+};
+export type GeneratedDocsConfig = {
+    $schema: string;
+    theme: 'mint';
+    name: string;
+    colors: {
+        primary: string;
+    };
+    navigation: {
+        groups: NavGroup[];
+    };
+};
+/**
+ * Builds a minimal docs.json for a folder of Markdown files with no config: root pages form
+ * the first group and each top-level folder becomes a group, with nested folders as subgroups.
+ */
+export declare const generateDocsConfig: (filePaths: string[], name: string) => GeneratedDocsConfig;
+export {};

package/dist/generate-docs-config.js

@@ -0,0 +1,59 @@
+import { slugToTitle } from '@mintlify/common';
+import pathUtil from 'path';
+const PAGE_EXTENSION = /\.mdx?$/i;
+const EXCLUDED_SEGMENTS = new Set(['node_modules', 'snippets']);
+const LEADING_PAGES = ['index', 'readme'];
+const isContentPage = (filePath) => PAGE_EXTENSION.test(filePath) &&
+    filePath
+        .split('/')
+        .every((segment) => !segment.startsWith('.') && !segment.startsWith('_') && !EXCLUDED_SEGMENTS.has(segment));
+const compareNames = (a, b) => {
+    const rank = (name) => {
+        const index = LEADING_PAGES.indexOf(pathUtil.posix.basename(name).toLowerCase());
+        return index === -1 ? LEADING_PAGES.length : index;
+    };
+    return rank(a) - rank(b) || a.localeCompare(b, undefined, { numeric: true, sensitivity: 'base' });
+};
+const folderTitle = (folder) => slugToTitle(folder.replace(/^\d+[-_.\s]+/, ''));
+const toPages = (node) => [
+    ...[...node.pages].sort(compareNames),
+    ...[...node.folders.entries()]
+        .sort(([a], [b]) => compareNames(a, b))
+        .map(([name, child]) => ({ group: folderTitle(name), pages: toPages(child) })),
+];
+/**
+ * Builds a minimal docs.json for a folder of Markdown files with no config: root pages form
+ * the first group and each top-level folder becomes a group, with nested folders as subgroups.
+ */
+export const generateDocsConfig = (filePaths, name) => {
+    const root = { pages: [], folders: new Map() };
+    for (const filePath of filePaths.map((path) => path.replaceAll('\\', '/'))) {
+        if (!isContentPage(filePath))
+            continue;
+        const segments = filePath.replace(PAGE_EXTENSION, '').split('/');
+        const page = segments.join('/');
+        let node = root;
+        for (const segment of segments.slice(0, -1)) {
+            let child = node.folders.get(segment);
+            if (!child) {
+                child = { pages: [], folders: new Map() };
+                node.folders.set(segment, child);
+            }
+            node = child;
+        }
+        node.pages.push(page);
+    }
+    const groups = [];
+    if (root.pages.length)
+        groups.push({ group: 'Introduction', pages: [...root.pages].sort(compareNames) });
+    for (const [folder, child] of [...root.folders.entries()].sort(([a], [b]) => compareNames(a, b))) {
+        groups.push({ group: folderTitle(folder), pages: toPages(child) });
+    }
+    return {
+        $schema: 'https://mintlify.com/docs.json',
+        theme: 'mint',
+        name,
+        colors: { primary: '#16A34A' },
+        navigation: { groups },
+    };
+};

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from './fs/index.js';
 export * from './generate.js';
+export * from './generate-docs-config.js';
 export * from './utils.js';
 export * from './prebuild/index.js';
 export { getFaviconsConfig } from './prebuild/generateFavicons.js';

package/dist/index.js

@@ -1,5 +1,6 @@
 export * from './fs/index.js';
 export * from './generate.js';
+export * from './generate-docs-config.js';
 export * from './utils.js';
 export * from './prebuild/index.js';
 export { getFaviconsConfig } from './prebuild/generateFavicons.js';