mintlify 1.0.1 → 1.0.2

package/bin/index.js

@@ -1,2 +1,52 @@
 #! /usr/bin/env node
-console.log("Hello, World!");
+import { writeFileSync } from "fs";
+import inquirer from "inquirer";
+import { MintConfig } from "./templates.js";
+const args = process.argv.slice(2);
+if (args.length === 0) {
+    console.error(`No command specified. Here are is the list that you can use:\ninit: initialize a Mintlify documentation instance`);
+    process.exit(1); //an error occurred
+}
+if (args[0] === "init") {
+    inquirer
+        .prompt([
+        {
+            type: "input",
+            name: "name",
+            message: "What is the name of the organization?",
+        },
+        {
+            type: "input",
+            name: "color",
+            message: "What is the primary color of the brand?",
+            default: "#3b83f4",
+        },
+        {
+            type: "input",
+            name: "ctaName",
+            message: "What is the name of the call to action button?",
+            default: "Get Started",
+        },
+        {
+            type: "input",
+            name: "ctaUrl",
+            message: "What is the URL destination of the call to action button?",
+            default: "/",
+        },
+        {
+            type: "input",
+            name: "title",
+            message: "What is the title of the first page?",
+            default: "Introduction",
+        },
+    ])
+        .then((answers) => {
+        const { name, color, ctaName, ctaUrl, title } = answers;
+        writeFileSync("mint.config.json", JSON.stringify(MintConfig(name, color, ctaName, ctaUrl, title), null, "\t"));
+    })
+        .catch((error) => {
+        console.error(error);
+        process.exit(1);
+    });
+}
+//# sourceMappingURL=index.js.map

package/bin/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,IAAI,CAAC;AACnC,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAE5C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEnC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;IACrB,OAAO,CAAC,KAAK,CACX,kHAAkH,CACnH,CAAC;IACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,mBAAmB;CACrC;AAED,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE;IACtB,QAAQ;SACL,MAAM,CAAC;QACN;YACE,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,uCAAuC;SACjD;QACD;YACE,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,OAAO;YACb,OAAO,EAAE,yCAAyC;YAClD,OAAO,EAAE,SAAS;SACnB;QACD;YACE,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,gDAAgD;YACzD,OAAO,EAAE,aAAa;SACvB;QACD;YACE,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,2DAA2D;YACpE,OAAO,EAAE,GAAG;SACb;QACD;YACE,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,OAAO;YACb,OAAO,EAAE,sCAAsC;YAC/C,OAAO,EAAE,cAAc;SACxB;KACF,CAAC;SACD,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;QAChB,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;QACxD,aAAa,CACX,kBAAkB,EAClB,IAAI,CAAC,SAAS,CACZ,UAAU,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAC/C,IAAI,EACJ,IAAI,CACL,CACF,CAAC;IACJ,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;CACN"}

package/bin/templates.js

@@ -0,0 +1,24 @@
+export const MintConfig = (name, color, ctaName, ctaUrl, title) => {
+    return {
+        name,
+        logo: "",
+        favicon: "",
+        colors: {
+            primary: color,
+        },
+        topbarLinks: [],
+        topbarCtaButton: {
+            name: ctaName,
+            url: ctaUrl,
+        },
+        anchors: [],
+        navigation: [
+            {
+                group: "Home",
+                pages: [title],
+            },
+        ],
+        // footerSocials: {}, // support object type for footer tyoes
+    };
+};
+//# sourceMappingURL=templates.js.map

package/bin/templates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.js","sourceRoot":"","sources":["../src/templates.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,IAAY,EACZ,KAAa,EACb,OAAe,EACf,MAAc,EACd,KAAa,EACb,EAAE;IACF,OAAO;QACL,IAAI;QACJ,IAAI,EAAE,EAAE;QACR,OAAO,EAAE,EAAE;QACX,MAAM,EAAE;YACN,OAAO,EAAE,KAAK;SACf;QACD,WAAW,EAAE,EAAE;QACf,eAAe,EAAE;YACf,IAAI,EAAE,OAAO;YACb,GAAG,EAAE,MAAM;SACZ;QACD,OAAO,EAAE,EAAE;QACX,UAAU,EAAE;YACV;gBACE,KAAK,EAAE,MAAM;gBACb,KAAK,EAAE,CAAC,KAAK,CAAC;aACf;SACF;QACD,6DAA6D;KAC9D,CAAC;AACJ,CAAC,CAAC"}

package/package.json

@@ -1,13 +1,26 @@
 {
   "name": "mintlify",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Mintlify CLI",
+  "engines": {
+    "node": ">=14.16"
+  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "tsc"
   },
   "author": "Mintlify, Inc.",
   "license": "ISC",
+  "exports": "./bin/index.js",
   "bin": {
     "mintlify": "bin/index.js"
+  },
+  "type": "module",
+  "dependencies": {
+    "inquirer": "^9.1.0"
+  },
+  "devDependencies": {
+    "@types/inquirer": "^9.0.1",
+    "@types/node": "^18.7.13",
+    "typescript": "^4.8.2"
   }
 }

package/src/index.ts

@@ -0,0 +1,64 @@
+#! /usr/bin/env node
+
+import { writeFileSync } from "fs";
+import inquirer from "inquirer";
+import { MintConfig } from "./templates.js";
+
+const args = process.argv.slice(2);
+
+if (args.length === 0) {
+  console.error(
+    `No command specified. Here are is the list that you can use:\ninit: initialize a Mintlify documentation instance`
+  );
+  process.exit(1); //an error occurred
+}
+
+if (args[0] === "init") {
+  inquirer
+    .prompt([
+      {
+        type: "input",
+        name: "name",
+        message: "What is the name of the organization?",
+      },
+      {
+        type: "input",
+        name: "color",
+        message: "What is the primary color of the brand?",
+        default: "#3b83f4",
+      },
+      {
+        type: "input",
+        name: "ctaName",
+        message: "What is the name of the call to action button?",
+        default: "Get Started",
+      },
+      {
+        type: "input",
+        name: "ctaUrl",
+        message: "What is the URL destination of the call to action button?",
+        default: "/",
+      },
+      {
+        type: "input",
+        name: "title",
+        message: "What is the title of the first page?",
+        default: "Introduction",
+      },
+    ])
+    .then((answers) => {
+      const { name, color, ctaName, ctaUrl, title } = answers;
+      writeFileSync(
+        "mint.config.json",
+        JSON.stringify(
+          MintConfig(name, color, ctaName, ctaUrl, title),
+          null,
+          "\t"
+        )
+      );
+    })
+    .catch((error) => {
+      console.error(error);
+      process.exit(1);
+    });
+}

package/src/templates.ts

@@ -0,0 +1,29 @@
+export const MintConfig = (
+  name: string,
+  color: string,
+  ctaName: string,
+  ctaUrl: string,
+  title: string
+) => {
+  return {
+    name,
+    logo: "",
+    favicon: "",
+    colors: {
+      primary: color,
+    },
+    topbarLinks: [],
+    topbarCtaButton: {
+      name: ctaName,
+      url: ctaUrl,
+    },
+    anchors: [],
+    navigation: [
+      {
+        group: "Home",
+        pages: [title],
+      },
+    ],
+    // footerSocials: {}, // support object type for footer tyoes
+  };
+};

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "module": "node16",
+    "moduleResolution": "node16",
+    "target": "es2017",
+    "lib": ["es2015"],
+    "sourceMap": true,
+    "outDir": "bin",
+    "baseUrl": ".",
+    "paths": {
+      "*": ["node_modules/*", "src/types/*"]
+    },
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true
+  },
+  "include": ["src/**/*"]
+}