@mintlify/previewing 4.0.1517 → 4.0.1519

package/dist/local-preview/ensure-docs-config.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Lets `mint dev` run on a plain folder of Markdown: when there is no docs.json or mint.json,
+ * writes a docs.json whose navigation mirrors the folder structure.
+ */
+export declare const ensureDocsConfig: () => Promise<void>;

package/dist/local-preview/ensure-docs-config.js

@@ -0,0 +1,39 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { slugToTitle } from '@mintlify/common';
+import { generateDocsConfig, getFileListSync, getMintIgnore } from '@mintlify/prebuild';
+import fse from 'fs-extra';
+import pathUtil from 'path';
+import { CMD_EXEC_PATH } from '../constants.js';
+import { addLog } from '../logging-state.js';
+import { InfoLog } from '../logs.js';
+const readPackageName = async (directory) => {
+    try {
+        const packageJson = await fse.readJson(pathUtil.join(directory, 'package.json'));
+        if (packageJson && typeof packageJson === 'object' && 'name' in packageJson) {
+            const { name } = packageJson;
+            if (typeof name === 'string' && name)
+                return name.replace(/^@[^/]+\//, '');
+        }
+    }
+    catch { }
+    return undefined;
+};
+/**
+ * Lets `mint dev` run on a plain folder of Markdown: when there is no docs.json or mint.json,
+ * writes a docs.json whose navigation mirrors the folder structure.
+ */
+export const ensureDocsConfig = async () => {
+    const hasConfig = await Promise.all(['docs.json', 'mint.json'].map((file) => fse.pathExists(pathUtil.join(CMD_EXEC_PATH, file))));
+    if (hasConfig.some(Boolean))
+        return;
+    const mintIgnore = await getMintIgnore(CMD_EXEC_PATH);
+    const files = getFileListSync(CMD_EXEC_PATH, CMD_EXEC_PATH, mintIgnore);
+    const name = (await readPackageName(CMD_EXEC_PATH)) ??
+        (await readPackageName(pathUtil.dirname(CMD_EXEC_PATH))) ??
+        slugToTitle(pathUtil.basename(CMD_EXEC_PATH));
+    const docsConfig = generateDocsConfig(files, name);
+    if (!docsConfig.navigation.groups.length)
+        return;
+    await fse.writeJson(pathUtil.join(CMD_EXEC_PATH, 'docs.json'), docsConfig, { spaces: 2 });
+    addLog(_jsx(InfoLog, { message: "No docs.json found, so one was generated from your folder structure.", detail: "Edit docs.json to customize navigation, theme, and colors." }));
+};

package/dist/local-preview/index.js

@@ -9,6 +9,7 @@ import { ErrorLog, SpinnerLog } from '../logs.js';
 import { isNativePackagesEnabled } from '../packages/flag.js';
 import { seedPreviewFromShared } from '../util.js';
 import { timeDev, timeDevSync } from './dev-timing.js';
+import { ensureDocsConfig } from './ensure-docs-config.js';
 import { startPackagesDev } from './packages/index.js';
 import { acquirePreviewLock } from './preview-lock.js';
 import { run } from './run.js';
@@ -67,6 +68,7 @@ const startDev = async (argv) => {
         await new Promise((resolve) => setTimeout(resolve, 50));
         process.exit(1);
     }
+    await timeDev('ensure docs.json', () => ensureDocsConfig());
     // clear preexisting prebuild files
     timeDevSync('clear prebuild output', () => {
         fse.emptyDirSync(NEXT_PROPS_PATH);