@mintlify/previewing 3.0.0

package/.eslintignore

@@ -0,0 +1 @@
+bin/

package/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "@mintlify/eslint-config-typescript"
+}

package/CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Running CLI Locally
+
+Note - contributing requires `yarn` and it's recommended you install it as a global installation. If you don't have yarn installed already run `npm install --global yarn` in your terminal.
+
+Run `npm run local` to build and install the CLI locally.
+
+You need to run the command after every change you want to test.
+
+## Updating Version of Mint Client
+
+The CLI uses GitHub releases to download specific versions of the client code used in `mintlify dev`. Older CLI versions will continue using the client code they were bundled with. Users need to update to a newer version of the CLI to get the newest client code. CLI contributors bump the client version used by the CLI whenever there are major changes.
+
+Here's how to publish new client changes to the CLI:
+
+1. Publish a new GitHub release. You can click the releases menu at the right of the repo page. Make the release title the same as the new release tag. Optionally, you can also use the description to keep track of what changed in that release.
+2. Set `TARGET_MINT_VERSION` in `src/constants.ts` to to the new release tag.
+3. Publish a new CLI version to npm.

package/README.md

@@ -0,0 +1,78 @@
+<div align="center">
+  <a href="https://mintlify.com">
+    <img
+      src="https://res.cloudinary.com/mintlify/image/upload/v1665385627/logo-rounded_zuk7q1.svg"
+      alt="Mintlify Logo"
+      height="64"
+    />
+  </a>
+  <br />
+  <p>
+    <h3>
+      <b>
+        Mintlify CLI
+      </b>
+    </h3>
+  </p>
+  <p>
+    The Mintlify CLI is the easiest way to build Mintlify apps from the command line.
+  </p>
+  <p>
+
+[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen?logo=github)](/) [![Website](https://img.shields.io/website?url=https%3A%2F%2Fmintlify.com&logo=mintlify)](https://mintlify.com) [![Unit Tests](https://github.com/mintlify/mint/actions/workflows/unit-tests.yaml/badge.svg)](https://github.com/mintlify/mint/actions/workflows/unit-tests.yaml) [![Tweet](https://img.shields.io/twitter/url?url=https%3A%2F%2Fmintlify.com%2F)](https://twitter.com/intent/tweet?url=&text=Check%20out%20%40mintlify) [![Chat on Discord](https://img.shields.io/badge/chat-Discord-7289DA?logo=discord)](https://discord.gg/MPNgtSZkgK) [![Discuss on GitHub](https://img.shields.io/badge/discussions-GitHub-333333?logo=github)](https://github.com/mintlify/mint/discussions)
+
+  </p>
+  <p>
+    <sub>
+      Built with ❤︎ by
+      <a href="https://mintlify.com">
+        Mintlify
+      </a>
+    </sub>
+  </p>
+</div>
+
+### 🚀 Installation
+
+Download the Mintlify CLI using the following command
+
+```
+npm i -g mintlify
+```
+
+### 👩‍💻 Development
+
+Run the following command at the root of your Mintlify application to preview changes locally.
+
+```
+mintlify dev
+```
+
+Note - `mintlify dev` requires `yarn` and it's recommended you install it as a global installation. If you don't have yarn installed already run `npm install --global yarn` in your terminal.
+
+### Custom Ports
+
+Mintlify uses port 3000 by default. You can use the `--port` flag to customize the port Mintlify runs on. For example, use this command to run in port 3333:
+
+```
+mintlify dev --port 3333
+```
+
+You will see an error like this if you try to run Mintlify in a port that's already taken:
+
+```
+Error: listen EADDRINUSE: address already in use :::3000
+```
+
+#### Troubleshooting
+
+Steps you can take if the dev CLI is not working (After each step try to run `mintlify dev` again):
+
+- Make sure you are running in a folder with a `mint.json` file.
+- Make sure you are using Node v18 or higher.
+- Run `mintlify install` to re-install dependencies.
+- Navigate to the `.mintlify` folder in your home directory and delete its contents.
+
+### 🏃 Get Started
+
+[Create an account](https://mintlify.com/start) to start using Mintlify for your documentation.

package/bin/constants.js

@@ -0,0 +1,32 @@
+import path from "path";
+import * as url from "url";
+import os from "os";
+// Change this to bump to a newer version of mint's client
+export const TARGET_MINT_VERSION = "v0.0.9";
+// package installation location
+export const INSTALL_PATH = url.fileURLToPath(new URL(".", import.meta.url));
+export const HOME_DIR = os.homedir();
+export const DOT_MINTLIFY = path.join(HOME_DIR, ".mintlify");
+export const VERSION_PATH = path.join(DOT_MINTLIFY, "mint", "mint-version.txt");
+export const CLIENT_PATH = path.join(DOT_MINTLIFY, "mint", "client");
+export const MINT_PATH = path.join(DOT_MINTLIFY, "mint");
+// command execution location
+export const CMD_EXEC_PATH = process.cwd();
+export const SUPPORTED_MEDIA_EXTENSIONS = [
+    "jpeg",
+    "jpg",
+    "jfif",
+    "pjpeg",
+    "pjp",
+    "png",
+    "svg",
+    "svgz",
+    "ico",
+    "webp",
+    "gif",
+    "apng",
+    "avif",
+    "bmp",
+    "mp4",
+];
+//# sourceMappingURL=constants.js.map

package/bin/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAC3B,OAAO,EAAE,MAAM,IAAI,CAAC;AAEpB,0DAA0D;AAC1D,MAAM,CAAC,MAAM,mBAAmB,GAAG,QAAQ,CAAC;AAE5C,gCAAgC;AAChC,MAAM,CAAC,MAAM,YAAY,GAAG,GAAG,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAE7E,MAAM,CAAC,MAAM,QAAQ,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;AAErC,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;AAE7D,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,kBAAkB,CAAC,CAAC;AAEhF,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;AAErE,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;AAEzD,6BAA6B;AAC7B,MAAM,CAAC,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;AAE3C,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,MAAM;IACN,KAAK;IACL,MAAM;IACN,OAAO;IACP,KAAK;IACL,KAAK;IACL,KAAK;IACL,MAAM;IACN,KAAK;IACL,MAAM;IACN,KAAK;IACL,MAAM;IACN,MAAM;IACN,KAAK;IACL,KAAK;CACN,CAAC"}

package/bin/downloadImage.js

@@ -0,0 +1,82 @@
+import { existsSync, mkdirSync, createWriteStream } from "fs";
+import path from "path";
+import axios from "axios";
+import { getFileExtension } from "./util.js";
+import { SUPPORTED_MEDIA_EXTENSIONS } from "./constants.js";
+async function writeImageToFile(imageSrc, writePath, overwrite) {
+    // Avoid unnecessary downloads
+    if (existsSync(writePath) && !overwrite) {
+        return Promise.reject({
+            code: "EEXIST",
+        });
+    }
+    // Create the folders needed if they're missing
+    mkdirSync(path.dirname(writePath), { recursive: true });
+    const writer = createWriteStream(writePath);
+    try {
+        const response = await axios.get(imageSrc, {
+            responseType: "stream",
+        });
+        // wx prevents overwriting an image with the exact same name
+        // being created in the time we were downloading
+        response.data.pipe(writer, {
+            flag: "wx",
+        });
+        return new Promise((resolve, reject) => {
+            writer.on("finish", resolve);
+            writer.on("error", reject);
+        });
+    }
+    catch (e) {
+        return Promise.reject({
+            code: "ENOTFOUND",
+        });
+    }
+}
+export function isValidImageSrc(src) {
+    if (!src) {
+        return false;
+    }
+    // We do not support downloading base64 in-line images.
+    if (src.startsWith("data:")) {
+        return false;
+    }
+    const imageHref = removeMetadataFromImageSrc(src);
+    const ext = getFileExtension(imageHref);
+    if (ext && !SUPPORTED_MEDIA_EXTENSIONS.includes(ext)) {
+        console.error("🚨 We do not support the file extension: " + ext);
+        return false;
+    }
+    return true;
+}
+export function removeMetadataFromImageSrc(src) {
+    // Part of the URL standard
+    const metadataSymbols = ["?", "#"];
+    metadataSymbols.forEach((dividerSymbol) => {
+        // Some frameworks add metadata after the file extension, we need to remove that.
+        src = src.split(dividerSymbol)[0];
+    });
+    return src;
+}
+export function cleanImageSrc(src, origin) {
+    // Add origin if the image tags are using relative sources
+    return src.startsWith("http") ? src : new URL(src, origin).href;
+}
+export default async function downloadImage(imageSrc, writePath, overwrite = false) {
+    await writeImageToFile(imageSrc, writePath, overwrite)
+        .then(() => {
+        console.log("🖼️ - " + writePath);
+    })
+        .catch((e) => {
+        if (e.code === "EEXIST") {
+            console.log(`❌ Skipping existing image ${writePath}`);
+        }
+        else if (e.code === "ENOTFOUND") {
+            console.error(`🚨 Cannot download the image, address not found ${imageSrc}`);
+        }
+        else {
+            console.error(e);
+        }
+    });
+}
+//# sourceMappingURL=downloadImage.js.map

package/bin/downloadImage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"downloadImage.js","sourceRoot":"","sources":["../src/downloadImage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,IAAI,CAAC;AAC9D,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,0BAA0B,EAAE,MAAM,gBAAgB,CAAC;AAE5D,KAAK,UAAU,gBAAgB,CAC7B,QAAgB,EAChB,SAAiB,EACjB,SAAkB;IAElB,8BAA8B;IAC9B,IAAI,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,EAAE;QACvC,OAAO,OAAO,CAAC,MAAM,CAAC;YACpB,IAAI,EAAE,QAAQ;SACf,CAAC,CAAC;KACJ;IAED,+CAA+C;IAC/C,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAExD,MAAM,MAAM,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAE5C,IAAI;QACF,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE;YACzC,YAAY,EAAE,QAAQ;SACvB,CAAC,CAAC;QACH,4DAA4D;QAC5D,gDAAgD;QAChD,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACzB,IAAI,EAAE,IAAI;SACX,CAAC,CAAC;QAEH,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YAC7B,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;KACJ;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,OAAO,CAAC,MAAM,CAAC;YACpB,IAAI,EAAE,WAAW;SAClB,CAAC,CAAC;KACJ;AACH,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,GAAW;IACzC,IAAI,CAAC,GAAG,EAAE;QACR,OAAO,KAAK,CAAC;KACd;IACD,uDAAuD;IACvD,IAAI,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;QAC3B,OAAO,KAAK,CAAC;KACd;IAED,MAAM,SAAS,GAAG,0BAA0B,CAAC,GAAG,CAAC,CAAC;IAClD,MAAM,GAAG,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAExC,IAAI,GAAG,IAAI,CAAC,0BAA0B,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QACpD,OAAO,CAAC,KAAK,CAAC,2CAA2C,GAAG,GAAG,CAAC,CAAC;QACjE,OAAO,KAAK,CAAC;KACd;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,GAAW;IACpD,2BAA2B;IAC3B,MAAM,eAAe,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAEnC,eAAe,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;QACxC,iFAAiF;QACjF,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,GAAW,EAAE,MAAc;IACvD,0DAA0D;IAC1D,OAAO,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC;AAClE,CAAC;AAED,MAAM,CAAC,OAAO,CAAC,KAAK,UAAU,aAAa,CACzC,QAAgB,EAChB,SAAiB,EACjB,SAAS,GAAG,KAAK;IAEjB,MAAM,gBAAgB,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,CAAC;SACnD,IAAI,CAAC,GAAG,EAAE;QACT,OAAO,CAAC,GAAG,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAC;IACpC,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;QACX,IAAI,CAAC,CAAC,IAAI,KAAK,QAAQ,EAAE;YACvB,OAAO,CAAC,GAAG,CAAC,6BAA6B,SAAS,EAAE,CAAC,CAAC;SACvD;aAAM,IAAI,CAAC,CAAC,IAAI,KAAK,WAAW,EAAE;YACjC,OAAO,CAAC,KAAK,CACX,mDAAmD,QAAQ,EAAE,CAC9D,CAAC;SACH;aAAM;YACL,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAClB;IACH,CAAC,CAAC,CAAC;AACP,CAAC"}

package/bin/index.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+/* eslint-disable @typescript-eslint/no-empty-function */
+import yargs from "yargs";
+import { hideBin } from "yargs/helpers.js";
+import dev from "./local-preview/index.js";
+import installDepsCommand from "./local-preview/helper-commands/installDepsCommand.js";
+yargs(hideBin(process.argv))
+    .command("dev", "Runs Mintlify locally (Must run in directory with mint.json)", () => { }, async (argv) => {
+    await dev(argv);
+})
+    .command("install", "Install dependencies for local Mintlify", () => { }, installDepsCommand)
+    // Print the help menu when the user enters an invalid command.
+    .strictCommands()
+    .demandCommand(1, "Unknown command. See above for the list of supported commands.")
+    // Alias option flags --help = -h, --version = -v
+    .alias("h", "help")
+    .alias("v", "version")
+    .parse();
+//# sourceMappingURL=index.js.map

package/bin/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,yDAAyD;AAEzD,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,GAAG,MAAM,0BAA0B,CAAC;AAC3C,OAAO,kBAAkB,MAAM,uDAAuD,CAAC;AAEvF,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;KACzB,OAAO,CACN,KAAK,EACL,8DAA8D,EAC9D,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC;AAClB,CAAC,CACF;KACA,OAAO,CACN,SAAS,EACT,yCAAyC,EACzC,GAAG,EAAE,GAAE,CAAC,EACR,kBAAkB,CACnB;IACD,+DAA+D;KAC9D,cAAc,EAAE;KAChB,aAAa,CACZ,CAAC,EACD,gEAAgE,CACjE;IAED,iDAAiD;KAChD,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC;KAClB,KAAK,CAAC,GAAG,EAAE,SAAS,CAAC;KAErB,KAAK,EAAE,CAAC"}

package/bin/local-preview/helper-commands/installDepsCommand.js

@@ -0,0 +1,12 @@
+import shell from "shelljs";
+import { CLIENT_PATH } from "../../constants.js";
+import { buildLogger, ensureYarn } from "../../util.js";
+const installDeps = async () => {
+    const logger = buildLogger("");
+    ensureYarn(logger);
+    shell.cd(CLIENT_PATH);
+    shell.exec("yarn");
+    logger.succeed("Dependencies installed.");
+};
+export default installDeps;
+//# sourceMappingURL=installDepsCommand.js.map

package/bin/local-preview/helper-commands/installDepsCommand.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"installDepsCommand.js","sourceRoot":"","sources":["../../../src/local-preview/helper-commands/installDepsCommand.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAExD,MAAM,WAAW,GAAG,KAAK,IAAI,EAAE;IAC7B,MAAM,MAAM,GAAG,WAAW,CAAC,EAAE,CAAC,CAAC;IAC/B,UAAU,CAAC,MAAM,CAAC,CAAC;IACnB,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IACtB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACnB,MAAM,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC;AAC5C,CAAC,CAAC;AAEF,eAAe,WAAW,CAAC"}

package/bin/local-preview/index.js

@@ -0,0 +1,154 @@
+import Chalk from "chalk";
+import child_process from "child_process";
+import open from "open";
+import fse, { pathExists } from "fs-extra";
+import inquirer from "inquirer";
+import { isInternetAvailable } from "is-internet-available";
+import path from "path";
+import shell from "shelljs";
+import { Octokit } from "@octokit/rest";
+import { CLIENT_PATH, HOME_DIR, DOT_MINTLIFY, CMD_EXEC_PATH, TARGET_MINT_VERSION, VERSION_PATH, MINT_PATH, } from "../constants.js";
+import { buildLogger, ensureYarn } from "../util.js";
+import listener from "./listener/index.js";
+import { getConfigPath } from "./listener/utils/mintConfigFile.js";
+const nodeModulesExists = async () => {
+    return pathExists(path.join(DOT_MINTLIFY, "mint", "client", "node_modules"));
+};
+const promptForYarn = async () => {
+    const yarnInstalled = shell.which("yarn");
+    if (!yarnInstalled) {
+        await inquirer
+            .prompt([
+            {
+                type: "confirm",
+                name: "confirm",
+                message: "yarn must be globally installed. Install yarn?",
+                default: true,
+            },
+        ])
+            .then(({ confirm }) => {
+            if (confirm) {
+                shell.exec("npm install --global yarn");
+            }
+            else {
+                console.log("Installation cancelled.");
+            }
+        });
+    }
+};
+const downloadTargetMint = async (logger) => {
+    fse.emptyDirSync(MINT_PATH);
+    logger.text = "Downloading Mintlify framework...";
+    const octokit = new Octokit();
+    const downloadRes = await octokit.repos.downloadTarballArchive({
+        owner: "mintlify",
+        repo: "mint",
+        ref: TARGET_MINT_VERSION,
+    });
+    logger.text = "Extracting Mintlify framework...";
+    const TAR_PATH = path.join(MINT_PATH, "mint.tar.gz");
+    fse.writeFileSync(TAR_PATH, Buffer.from(downloadRes.data));
+    // strip-components 1 removes the top level directory from the unzipped content
+    // which is a folder with the release sha
+    fse.mkdirSync(path.join(MINT_PATH, "mint-tmp"));
+    shell.exec("tar -xzf mint.tar.gz -C mint-tmp --strip-components 1", {
+        silent: true,
+    });
+    fse.removeSync(TAR_PATH);
+    fse.moveSync(path.join(MINT_PATH, "mint-tmp", "client"), path.join(CLIENT_PATH));
+    fse.writeFileSync(VERSION_PATH, TARGET_MINT_VERSION);
+    // Delete unnecessary content downloaded from GitHub
+    fse.removeSync(path.join(MINT_PATH, "mint-tmp"));
+    logger.text = "Installing dependencies...";
+    ensureYarn(logger);
+    shell.cd(CLIENT_PATH);
+    shell.exec("yarn", { silent: true });
+};
+const checkForMintJson = async (logger) => {
+    const configPath = await getConfigPath(CMD_EXEC_PATH);
+    if (configPath == null) {
+        logger.fail("Must be ran in a directory where a mint.json file exists.");
+        process.exit(1);
+    }
+    return;
+};
+const dev = async (argv) => {
+    shell.cd(HOME_DIR);
+    await promptForYarn();
+    const logger = buildLogger("Preparing local Mintlify instance...");
+    await fse.ensureDir(MINT_PATH);
+    shell.cd(MINT_PATH);
+    const internet = await isInternetAvailable();
+    if (!internet && !(await pathExists(CLIENT_PATH))) {
+        logger.fail("Running mintlify dev for the first time requires an internet connection.");
+        process.exit(1);
+    }
+    if (internet) {
+        const mintVersionExists = await pathExists(VERSION_PATH);
+        let needToDownloadTargetMint = !mintVersionExists;
+        if (mintVersionExists) {
+            const currVersion = fse.readFileSync(VERSION_PATH, "utf8");
+            if (currVersion !== TARGET_MINT_VERSION) {
+                needToDownloadTargetMint = true;
+            }
+        }
+        if (needToDownloadTargetMint) {
+            await downloadTargetMint(logger);
+        }
+    }
+    if (!(await nodeModulesExists())) {
+        if (!internet) {
+            logger.fail(`Dependencies are missing and you are offline. Connect to the internet and run
+  
+      mintlify install
+      
+      `);
+        }
+        else {
+            logger.fail(`Dependencies were not installed correctly, run
+  
+      mintlify install
+      
+      `);
+        }
+        process.exit(1);
+    }
+    await checkForMintJson(logger);
+    shell.cd(CLIENT_PATH);
+    const relativePath = path.relative(CLIENT_PATH, CMD_EXEC_PATH);
+    child_process.spawnSync("yarn preconfigure", [relativePath], { shell: true });
+    logger.succeed("Local Mintlify instance is ready. Launching your site...");
+    run(argv.port || "3000");
+};
+const run = (port) => {
+    shell.cd(CLIENT_PATH);
+    // next-remote-watch can only receive ports as env variables
+    // https://github.com/hashicorp/next-remote-watch/issues/23
+    const mintlifyDevProcess = child_process.spawn("npm run dev-watch", {
+        env: {
+            ...process.env,
+            PORT: port,
+        },
+        cwd: CLIENT_PATH,
+        stdio: "pipe",
+        shell: true,
+    });
+    mintlifyDevProcess.stdout.on("data", (data) => {
+        const output = data.toString();
+        console.log(output);
+        if (output.startsWith("> Ready on http://localhost:")) {
+            console.log(`🌿 ${Chalk.green(`Your local preview is available at http://localhost:${port}`)}`);
+            console.log(`🌿 ${Chalk.green("Press Ctrl+C any time to stop the local preview.")}`);
+            open(`http://localhost:${port}`);
+        }
+    });
+    const onExit = () => {
+        mintlifyDevProcess.kill("SIGINT");
+        process.exit(0);
+    };
+    process.on("SIGINT", onExit);
+    process.on("SIGTERM", onExit);
+    listener();
+};
+export default dev;
+//# sourceMappingURL=index.js.map

package/bin/local-preview/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/local-preview/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,aAAa,MAAM,eAAe,CAAC;AAC1C,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,GAAG,EAAE,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EACL,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,aAAa,EACb,mBAAmB,EACnB,YAAY,EACZ,SAAS,GACV,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,QAAQ,MAAM,qBAAqB,CAAC;AAE3C,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AAGnE,MAAM,iBAAiB,GAAG,KAAK,IAAI,EAAE;IACnC,OAAO,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC;AAC/E,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,KAAK,IAAI,EAAE;IAC/B,MAAM,aAAa,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC1C,IAAI,CAAC,aAAa,EAAE;QAClB,MAAM,QAAQ;aACX,MAAM,CAAC;YACN;gBACE,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,gDAAgD;gBACzD,OAAO,EAAE,IAAI;aACd;SACF,CAAC;aACD,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;YACpB,IAAI,OAAO,EAAE;gBACX,KAAK,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;aACzC;iBAAM;gBACL,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;aACxC;QACH,CAAC,CAAC,CAAC;KACN;AACH,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;IACnD,GAAG,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAE5B,MAAM,CAAC,IAAI,GAAG,mCAAmC,CAAC;IAElD,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;IAC9B,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,sBAAsB,CAAC;QAC7D,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,MAAM;QACZ,GAAG,EAAE,mBAAmB;KACzB,CAAC,CAAC;IAEH,MAAM,CAAC,IAAI,GAAG,kCAAkC,CAAC;IACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;IACrD,GAAG,CAAC,aAAa,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,IAAW,CAAC,CAAC,CAAC;IAElE,+EAA+E;IAC/E,yCAAyC;IACzC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC;IAChD,KAAK,CAAC,IAAI,CAAC,uDAAuD,EAAE;QAClE,MAAM,EAAE,IAAI;KACb,CAAC,CAAC;IAEH,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAEzB,GAAG,CAAC,QAAQ,CACV,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,EAAE,QAAQ,CAAC,EAC1C,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CACvB,CAAC;IAEF,GAAG,CAAC,aAAa,CAAC,YAAY,EAAE,mBAAmB,CAAC,CAAC;IAErD,oDAAoD;IACpD,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC;IAEjD,MAAM,CAAC,IAAI,GAAG,4BAA4B,CAAC;IAE3C,UAAU,CAAC,MAAM,CAAC,CAAC;IACnB,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IACtB,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;IACjD,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,CAAC;IACtD,IAAI,UAAU,IAAI,IAAI,EAAE;QACtB,MAAM,CAAC,IAAI,CAAC,2DAA2D,CAAC,CAAC;QACzE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IACD,OAAO;AACT,CAAC,CAAC;AAEF,MAAM,GAAG,GAAG,KAAK,EAAE,IAAwB,EAAE,EAAE;IAC7C,KAAK,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;IACnB,MAAM,aAAa,EAAE,CAAC;IACtB,MAAM,MAAM,GAAG,WAAW,CAAC,sCAAsC,CAAC,CAAC;IACnE,MAAM,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IAC/B,KAAK,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;IAEpB,MAAM,QAAQ,GAAG,MAAM,mBAAmB,EAAE,CAAC;IAC7C,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,MAAM,UAAU,CAAC,WAAW,CAAC,CAAC,EAAE;QACjD,MAAM,CAAC,IAAI,CACT,0EAA0E,CAC3E,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,IAAI,QAAQ,EAAE;QACZ,MAAM,iBAAiB,GAAG,MAAM,UAAU,CAAC,YAAY,CAAC,CAAC;QAEzD,IAAI,wBAAwB,GAAG,CAAC,iBAAiB,CAAC;QAElD,IAAI,iBAAiB,EAAE;YACrB,MAAM,WAAW,GAAG,GAAG,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;YAC3D,IAAI,WAAW,KAAK,mBAAmB,EAAE;gBACvC,wBAAwB,GAAG,IAAI,CAAC;aACjC;SACF;QAED,IAAI,wBAAwB,EAAE;YAC5B,MAAM,kBAAkB,CAAC,MAAM,CAAC,CAAC;SAClC;KACF;IAED,IAAI,CAAC,CAAC,MAAM,iBAAiB,EAAE,CAAC,EAAE;QAChC,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,CAAC,IAAI,CAAC;;;;OAIX,CAAC,CAAC;SACJ;aAAM;YACL,MAAM,CAAC,IAAI,CAAC;;;;OAIX,CAAC,CAAC;SACJ;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IACD,MAAM,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC/B,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IACtB,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IAC/D,aAAa,CAAC,SAAS,CAAC,mBAAmB,EAAE,CAAC,YAAY,CAAC,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAC9E,MAAM,CAAC,OAAO,CAAC,0DAA0D,CAAC,CAAC;IAC3E,GAAG,CAAE,IAAI,CAAC,IAAe,IAAI,MAAM,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF,MAAM,GAAG,GAAG,CAAC,IAAY,EAAE,EAAE;IAC3B,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IAEtB,4DAA4D;IAC5D,2DAA2D;IAC3D,MAAM,kBAAkB,GAAG,aAAa,CAAC,KAAK,CAAC,mBAAmB,EAAE;QAClE,GAAG,EAAE;YACH,GAAG,OAAO,CAAC,GAAG;YACd,IAAI,EAAE,IAAI;SACX;QACD,GAAG,EAAE,WAAW;QAChB,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,IAAI;KACZ,CAAC,CAAC;IACH,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;QAC5C,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC/B,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACpB,IAAI,MAAM,CAAC,UAAU,CAAC,8BAA8B,CAAC,EAAE;YACrD,OAAO,CAAC,GAAG,CACT,MAAM,KAAK,CAAC,KAAK,CACf,uDAAuD,IAAI,EAAE,CAC9D,EAAE,CACJ,CAAC;YACF,OAAO,CAAC,GAAG,CACT,MAAM,KAAK,CAAC,KAAK,CAAC,kDAAkD,CAAC,EAAE,CACxE,CAAC;YACF,IAAI,CAAC,oBAAoB,IAAI,EAAE,CAAC,CAAC;SAClC;IACH,CAAC,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,GAAG,EAAE;QAClB,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC;IACF,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC7B,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAC9B,QAAQ,EAAE,CAAC;AACb,CAAC,CAAC;AAEF,eAAe,GAAG,CAAC"}

package/bin/local-preview/listener/categorize.js

@@ -0,0 +1,95 @@
+// TODO - put in prebuild package
+import path from "path";
+import { getFileExtension, openApiCheck, getFileList } from "./utils.js";
+export const categorizeFiles = async (contentDirectoryPath) => {
+    const allFilesInCmdExecutionPath = await getFileList(contentDirectoryPath);
+    const contentFilenames = [];
+    const staticFilenames = [];
+    const promises = [];
+    const openApiFiles = [];
+    const snippets = [];
+    allFilesInCmdExecutionPath.forEach((filename) => {
+        promises.push((async () => {
+            const extension = getFileExtension(filename);
+            let isOpenApi = false;
+            if (extension && (extension === "mdx" || extension === "md")) {
+                if (filename.startsWith("/_snippets")) {
+                    snippets.push(filename);
+                }
+                else {
+                    contentFilenames.push(filename);
+                }
+            }
+            else if (extension &&
+                (extension === "json" || extension === "yaml" || extension === "yml")) {
+                const openApiInfo = await openApiCheck(path.join(contentDirectoryPath, filename));
+                isOpenApi = openApiInfo.isOpenApi;
+                if (isOpenApi) {
+                    const fileName = path.parse(filename).base;
+                    openApiFiles.push({
+                        filename: fileName.substring(0, fileName.lastIndexOf(".")),
+                        spec: openApiInfo.spec,
+                    });
+                }
+            }
+            else if (!filename.endsWith("mint.json") && !isOpenApi) {
+                // all other files
+                staticFilenames.push(filename);
+            }
+        })());
+    });
+    await Promise.all(promises);
+    return { contentFilenames, staticFilenames, openApiFiles, snippets };
+};
+const excludedMdFiles = ["readme", "license", "contributing", "contribute"];
+const supportedStaticFileExtensions = [
+    ".jpeg",
+    ".jpg",
+    ".jfif",
+    ".pjpeg",
+    ".pjp",
+    ".png",
+    ".svg",
+    ".svgz",
+    ".ico",
+    ".webp",
+    ".gif",
+    ".apng",
+    ".avif",
+    ".bmp",
+    ".mp4",
+];
+export const getCategory = (filePath) => {
+    filePath = filePath.toLowerCase();
+    const parsed = path.parse(filePath);
+    if (parsed.base === "mint.json") {
+        return "mintConfig";
+    }
+    const fileName = parsed.name;
+    const extension = parsed.ext;
+    if (filePath.startsWith("_snippets") &&
+        (extension === ".mdx" || extension === ".md")) {
+        return "snippet";
+    }
+    else if (extension === ".mdx") {
+        return "page";
+    }
+    else if (extension === ".md") {
+        // Exclude common markdown files people don't want on their docs website
+        if (excludedMdFiles.includes(fileName)) {
+            throw new Error("Excluded Md File");
+        }
+        return "page";
+    }
+    else if (extension === ".yaml" || extension === ".yml") {
+        return "potentialYamlOpenApiSpec";
+    }
+    else if (extension === ".json") {
+        return "potentialJsonOpenApiSpec";
+    }
+    else if (supportedStaticFileExtensions.includes(extension)) {
+        return "staticFile";
+    }
+    throw new Error("Unsupported File Type, No change enacted");
+};
+//# sourceMappingURL=categorize.js.map

package/bin/local-preview/listener/categorize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"categorize.js","sourceRoot":"","sources":["../../../src/local-preview/listener/categorize.ts"],"names":[],"mappings":"AAAA,iCAAiC;AACjC,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAGzE,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,EAAE,oBAA4B,EAAE,EAAE;IACpE,MAAM,0BAA0B,GAAa,MAAM,WAAW,CAC5D,oBAAoB,CACrB,CAAC;IACF,MAAM,gBAAgB,GAAa,EAAE,CAAC;IACtC,MAAM,eAAe,GAAa,EAAE,CAAC;IACrC,MAAM,QAAQ,GAAoB,EAAE,CAAC;IACrC,MAAM,YAAY,GAAkB,EAAE,CAAC;IACvC,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,0BAA0B,CAAC,OAAO,CAAC,CAAC,QAAgB,EAAE,EAAE;QACtD,QAAQ,CAAC,IAAI,CACX,CAAC,KAAK,IAAI,EAAE;YACV,MAAM,SAAS,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YAC7C,IAAI,SAAS,GAAG,KAAK,CAAC;YACtB,IAAI,SAAS,IAAI,CAAC,SAAS,KAAK,KAAK,IAAI,SAAS,KAAK,IAAI,CAAC,EAAE;gBAC5D,IAAI,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;oBACrC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;iBACzB;qBAAM;oBACL,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;iBACjC;aACF;iBAAM,IACL,SAAS;gBACT,CAAC,SAAS,KAAK,MAAM,IAAI,SAAS,KAAK,MAAM,IAAI,SAAS,KAAK,KAAK,CAAC,EACrE;gBACA,MAAM,WAAW,GAAG,MAAM,YAAY,CACpC,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAC1C,CAAC;gBACF,SAAS,GAAG,WAAW,CAAC,SAAS,CAAC;gBAClC,IAAI,SAAS,EAAE;oBACb,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC;oBAC3C,YAAY,CAAC,IAAI,CAAC;wBAChB,QAAQ,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;wBAC1D,IAAI,EAAE,WAAW,CAAC,IAAI;qBACvB,CAAC,CAAC;iBACJ;aACF;iBAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE;gBACxD,kBAAkB;gBAClB,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;aAChC;QACH,CAAC,CAAC,EAAE,CACL,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAE5B,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC;AACvE,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,QAAQ,EAAE,SAAS,EAAE,cAAc,EAAE,YAAY,CAAC,CAAC;AAE5E,MAAM,6BAA6B,GAAG;IACpC,OAAO;IACP,MAAM;IACN,OAAO;IACP,QAAQ;IACR,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;IACN,OAAO;IACP,MAAM;IACN,OAAO;IACP,OAAO;IACP,MAAM;IACN,MAAM;CACP,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,QAAgB,EAAyB,EAAE;IACrE,QAAQ,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;IAElC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAEpC,IAAI,MAAM,CAAC,IAAI,KAAK,WAAW,EAAE;QAC/B,OAAO,YAAY,CAAC;KACrB;IAED,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC;IAC7B,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC;IAC7B,IACE,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC;QAChC,CAAC,SAAS,KAAK,MAAM,IAAI,SAAS,KAAK,KAAK,CAAC,EAC7C;QACA,OAAO,SAAS,CAAC;KAClB;SAAM,IAAI,SAAS,KAAK,MAAM,EAAE;QAC/B,OAAO,MAAM,CAAC;KACf;SAAM,IAAI,SAAS,KAAK,KAAK,EAAE;QAC9B,wEAAwE;QACxE,IAAI,eAAe,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;YACtC,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;SACrC;QACD,OAAO,MAAM,CAAC;KACf;SAAM,IAAI,SAAS,KAAK,OAAO,IAAI,SAAS,KAAK,MAAM,EAAE;QACxD,OAAO,0BAA0B,CAAC;KACnC;SAAM,IAAI,SAAS,KAAK,OAAO,EAAE;QAChC,OAAO,0BAA0B,CAAC;KACnC;SAAM,IAAI,6BAA6B,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;QAC5D,OAAO,YAAY,CAAC;KACrB;IAED,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;AAC9D,CAAC,CAAC"}

package/bin/local-preview/listener/generate.js

@@ -0,0 +1,74 @@
+// TODO - add types
+import { promises as _promises } from "fs";
+import { outputFile } from "fs-extra";
+import path from "path";
+import createPage from "./utils/createPage.js";
+import { categorizeFiles } from "./categorize.js";
+import { CMD_EXEC_PATH } from "../../constants.js";
+import { getConfigObj } from "./utils/mintConfigFile.js";
+const { readFile } = _promises;
+const pageMetadataKeys = [
+    "title",
+    "description",
+    "sidebarTitle",
+    "href",
+    "api",
+    "openapi",
+    "contentType",
+    "auth",
+    "version",
+    "mode",
+    "hideFooterPagination",
+    "authors",
+    "lastUpdatedDate",
+    "createdDate",
+    "size",
+];
+const generateDecoratedMintNavigationFromPages = (filenamePageMetadataMap, mintConfigNav) => {
+    const filenames = Object.keys(filenamePageMetadataMap);
+    const createNav = (nav) => {
+        return {
+            group: nav.group,
+            version: nav?.version,
+            pages: nav.pages.map((page) => {
+                if (typeof page === "string" && filenames.includes(page)) {
+                    return filenamePageMetadataMap[page];
+                }
+                return createNav(page);
+            }),
+        };
+    };
+    return mintConfigNav.map((nav) => createNav(nav));
+};
+const createFilenamePageMetadataMap = async (contentDirectoryPath, contentFilenames, openApiFiles, clientPath, writeFiles = false) => {
+    let pagesAcc = {};
+    const contentPromises = [];
+    contentFilenames.forEach((filename) => {
+        contentPromises.push((async () => {
+            const sourcePath = path.join(contentDirectoryPath, filename);
+            const contentStr = (await readFile(sourcePath)).toString();
+            const { slug, pageMetadata, pageContent } = await createPage(filename, contentStr, contentDirectoryPath, openApiFiles);
+            if (clientPath && writeFiles) {
+                const targetPath = path.join(clientPath, "src", "_props", filename);
+                await outputFile(targetPath, pageContent, {
+                    flag: "w",
+                });
+            }
+            pagesAcc = {
+                ...pagesAcc,
+                [slug]: pageMetadata,
+            };
+        })());
+    });
+    await Promise.all(contentPromises);
+    return pagesAcc;
+};
+export const generateNav = async () => {
+    const { contentFilenames, openApiFiles } = await categorizeFiles(CMD_EXEC_PATH);
+    const [filenamePageMetadataMap, configObj] = await Promise.all([
+        createFilenamePageMetadataMap(CMD_EXEC_PATH, contentFilenames, openApiFiles),
+        getConfigObj(CMD_EXEC_PATH),
+    ]);
+    return generateDecoratedMintNavigationFromPages(filenamePageMetadataMap, configObj?.navigation);
+};
+//# sourceMappingURL=generate.js.map

package/bin/local-preview/listener/generate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../../src/local-preview/listener/generate.ts"],"names":[],"mappings":"AAAA,mBAAmB;AACnB,OAAO,EAAE,QAAQ,IAAI,SAAS,EAAE,MAAM,IAAI,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD,MAAM,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC;AAgB/B,MAAM,gBAAgB,GAAG;IACvB,OAAO;IACP,aAAa;IACb,cAAc;IACd,MAAM;IACN,KAAK;IACL,SAAS;IACT,aAAa;IACb,MAAM;IACN,SAAS;IACT,MAAM;IACN,sBAAsB;IACtB,SAAS;IACT,iBAAiB;IACjB,aAAa;IACb,MAAM;CACE,CAAC;AAIX,MAAM,wCAAwC,GAAG,CAC/C,uBAAqD,EACrD,aAA+B,EACN,EAAE;IAC3B,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;IACvD,MAAM,SAAS,GAAG,CAAC,GAAmB,EAAgC,EAAE;QACtE,OAAO;YACL,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,OAAO,EAAE,GAAG,EAAE,OAAO;YACrB,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAyB,EAAE,EAAE;gBACjD,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;oBACxD,OAAO,uBAAuB,CAAC,IAAI,CAAC,CAAC;iBACtC;gBACD,OAAO,SAAS,CAAC,IAAsB,CAAC,CAAC;YAC3C,CAAC,CAAC;SACH,CAAC;IACJ,CAAC,CAAC;IAEF,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;AACpD,CAAC,CAAC;AAEF,MAAM,6BAA6B,GAAG,KAAK,EACzC,oBAA4B,EAC5B,gBAA0B,EAC1B,YAA2B,EAC3B,UAAmB,EACnB,UAAU,GAAG,KAAK,EAClB,EAAE;IACF,IAAI,QAAQ,GAAG,EAAE,CAAC;IAClB,MAAM,eAAe,GAAoB,EAAE,CAAC;IAC5C,gBAAgB,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QACpC,eAAe,CAAC,IAAI,CAClB,CAAC,KAAK,IAAI,EAAE;YACV,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAC;YAE7D,MAAM,UAAU,GAAG,CAAC,MAAM,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC3D,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,WAAW,EAAE,GAAG,MAAM,UAAU,CAC1D,QAAQ,EACR,UAAU,EACV,oBAAoB,EACpB,YAAY,CACb,CAAC;YACF,IAAI,UAAU,IAAI,UAAU,EAAE;gBAC5B,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;gBACpE,MAAM,UAAU,CAAC,UAAU,EAAE,WAAW,EAAE;oBACxC,IAAI,EAAE,GAAG;iBACV,CAAC,CAAC;aACJ;YACD,QAAQ,GAAG;gBACT,GAAG,QAAQ;gBACX,CAAC,IAAI,CAAC,EAAE,YAAY;aACrB,CAAC;QACJ,CAAC,CAAC,EAAE,CACL,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,MAAM,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IACnC,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,IAAI,EAAE;IACpC,MAAM,EAAE,gBAAgB,EAAE,YAAY,EAAE,GAAG,MAAM,eAAe,CAC9D,aAAa,CACd,CAAC;IACF,MAAM,CAAC,uBAAuB,EAAE,SAAS,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QAC7D,6BAA6B,CAC3B,aAAa,EACb,gBAAgB,EAChB,YAAY,CACb;QACD,YAAY,CAAC,aAAa,CAAC;KAC5B,CAAC,CAAC;IACH,OAAO,wCAAwC,CAC7C,uBAAuB,EACvB,SAAS,EAAE,UAAU,CACtB,CAAC;AACJ,CAAC,CAAC"}