@mintlify/previewing 3.0.0 → 3.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/index.js +1 -1
- package/bin/index.js.map +1 -1
- package/bin/local-preview/listener/utils/createPage.js +9 -3
- package/bin/local-preview/listener/utils/createPage.js.map +1 -1
- package/bin/util.js +0 -30
- package/bin/util.js.map +1 -1
- package/package.json +1 -7
- package/src/index.ts +1 -1
- package/src/local-preview/listener/utils/createPage.ts +10 -6
- package/src/util.ts +0 -35
package/bin/index.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
/* eslint-disable @typescript-eslint/no-empty-function */
|
|
3
3
|
import yargs from "yargs";
|
|
4
|
-
import { hideBin } from "yargs/helpers
|
|
4
|
+
import { hideBin } from "yargs/helpers";
|
|
5
5
|
import dev from "./local-preview/index.js";
|
|
6
6
|
import installDepsCommand from "./local-preview/helper-commands/installDepsCommand.js";
|
|
7
7
|
yargs(hideBin(process.argv))
|
package/bin/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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,
|
|
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,eAAe,CAAC;AACxC,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"}
|
|
@@ -17,10 +17,16 @@ const createPage = async (pagePath, pageContent, contentDirectoryPath, openApiFi
|
|
|
17
17
|
// Replace .mdx so we can pass file paths into this function
|
|
18
18
|
const slug = pagePath.replace(/\.mdx?$/, "");
|
|
19
19
|
let defaultTitle = slugToTitle(slug);
|
|
20
|
+
let description;
|
|
20
21
|
// Append data from OpenAPI if it exists
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
22
|
+
if (metadata?.openapi) {
|
|
23
|
+
const { title, description: openApiDescription } = getOpenApiTitleAndDescription(openApiFiles, metadata?.openapi);
|
|
24
|
+
if (title) {
|
|
25
|
+
defaultTitle = title;
|
|
26
|
+
}
|
|
27
|
+
if (openApiDescription) {
|
|
28
|
+
description = openApiDescription;
|
|
29
|
+
}
|
|
24
30
|
}
|
|
25
31
|
const pageMetadata = {
|
|
26
32
|
title: defaultTitle,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createPage.js","sourceRoot":"","sources":["../../../../src/local-preview/listener/utils/createPage.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,iBAAiB,MAAM,oBAAoB,CAAC;AACnD,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC,MAAM,UAAU,GAAG,KAAK,EACtB,QAAgB,EAChB,WAAmB,EACnB,oBAA4B,EAC5B,YAA2B,EAC3B,EAAE;IACF,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;IAC/C,IAAI;QACF,MAAM,aAAa,GAAG,MAAM,WAAW,CAAC,WAAW,EAAE,oBAAoB,CAAC,CAAC;QAC3E,WAAW,GAAG,aAAa,CAAC;KAC7B;IAAC,OAAO,KAAK,EAAE;QACd,WAAW,GAAG,uEAAuE,CAAC;KACvF;IAED,4DAA4D;IAC5D,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IAC7C,IAAI,YAAY,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IACrC,wCAAwC;IACxC,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,
|
|
1
|
+
{"version":3,"file":"createPage.js","sourceRoot":"","sources":["../../../../src/local-preview/listener/utils/createPage.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,iBAAiB,MAAM,oBAAoB,CAAC;AACnD,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC,MAAM,UAAU,GAAG,KAAK,EACtB,QAAgB,EAChB,WAAmB,EACnB,oBAA4B,EAC5B,YAA2B,EAC3B,EAAE;IACF,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;IAC/C,IAAI;QACF,MAAM,aAAa,GAAG,MAAM,WAAW,CAAC,WAAW,EAAE,oBAAoB,CAAC,CAAC;QAC3E,WAAW,GAAG,aAAa,CAAC;KAC7B;IAAC,OAAO,KAAK,EAAE;QACd,WAAW,GAAG,uEAAuE,CAAC;KACvF;IAED,4DAA4D;IAC5D,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IAC7C,IAAI,YAAY,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,WAAmB,CAAC;IACxB,wCAAwC;IACxC,IAAI,QAAQ,EAAE,OAAO,EAAE;QACrB,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,kBAAkB,EAAE,GAC9C,6BAA6B,CAAC,YAAY,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAEjE,IAAI,KAAK,EAAE;YACT,YAAY,GAAG,KAAK,CAAC;SACtB;QACD,IAAI,kBAAkB,EAAE;YACtB,WAAW,GAAG,kBAAkB,CAAC;SAClC;KACF;IAED,MAAM,YAAY,GAAG;QACnB,KAAK,EAAE,YAAY;QACnB,WAAW;QACX,GAAG,QAAQ;QACX,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;KACtC,CAAC;IAEF,OAAO;QACL,YAAY;QACZ,WAAW;QACX,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;KAC/B,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,KAAK,EACvB,WAAmB,EACnB,oBAA4B,EAC5B,EAAE;IACF,MAAM,0BAA0B,GAAG,CAAC,QAAgB,EAAE,EAAE;QACtD,MAAM,OAAO,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;QACxC,MAAM,uBAAuB,GAAG,aAAa,CAAC,oBAAoB,CAAC,CAAC;QACpE,uBAAuB,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,KAAa,EAAE,EAAE;YACvE,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,GAAG,EAAE;gBAC1B,OAAO,CAAC,GAAG,EAAE,CAAC;aACf;QACH,CAAC,CAAC,CAAC;QACH,OAAO,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC,CAAC;IAEF,MAAM,2BAA2B,GAAG,GAAG,EAAE;QACvC,OAAO,CAAC,IAAI,EAAE,EAAE;YACd,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE;gBACnB,IAAI,IAAI,IAAI,IAAI,EAAE;oBAChB,OAAO;iBACR;gBACD,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE;oBACjD,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAC5C,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,KAAK,CAC/B,CAAC;oBACF,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC;oBACpD;oBACE,mBAAmB;oBACnB,YAAY,KAAK,CAAC,CAAC;wBACnB,CAAC,aAAa,CAAC,OAAO,CAAC;wBACvB,CAAC,YAAY,CAAC,OAAO,CAAC,EACtB;wBACA,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,KAAK;4BACjC,0BAA0B,CAAC,OAAO,CAAC,CAAC;qBACvC;iBACF;qBAAM;gBACL,eAAe;gBACf,IAAI,CAAC,IAAI,KAAK,OAAO;oBACrB,IAAI,CAAC,GAAG;oBACR,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC;oBACxB,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,EACvB;oBACA,IAAI,CAAC,GAAG,GAAG,0BAA0B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;iBACjD;YACH,CAAC,CAAC,CAAC;YACH,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;IACJ,CAAC,CAAC;IAEF,MAAM,IAAI,GAAG,MAAM,MAAM,EAAE;SACxB,GAAG,CAAC,SAAS,CAAC;SACd,GAAG,CAAC,SAAS,CAAC;SACd,GAAG,CAAC,iBAAiB,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;SACxC,GAAG,CAAC,2BAA2B,CAAC;SAChC,OAAO,CAAC,WAAW,CAAC,CAAC;IACxB,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;AACtB,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,GAAW,EAAE,EAAE;IACzC,MAAM,IAAI,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;IAChC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACxB,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,IAAY,EAAE,EAAE;IACrC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC;AACrD,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;AAE9D,MAAM,6BAA6B,GAAG,CACpC,YAA2B,EAC3B,gBAAwB,EACxB,EAAE;IACF,MAAM,EAAE,SAAS,EAAE,GAAG,oCAAoC,CACxD,YAAY,EACZ,gBAAgB,CACjB,CAAC;IAEF,IAAI,SAAS,IAAI,IAAI,EAAE;QACrB,OAAO,EAAE,CAAC;KACX;IAED,OAAO;QACL,KAAK,EAAE,SAAS,CAAC,OAAO;QACxB,WAAW,EAAE,SAAS,CAAC,WAAW;KACnC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,oCAAoC,GAAG,CAC3C,YAA2B,EAC3B,gBAAwB,EACxB,EAAE;IACF,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,GAClC,wBAAwB,CAAC,gBAAgB,CAAC,CAAC;IAE7C,IAAI,IAAI,CAAC;IAET,YAAY,EAAE,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC7B,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC;QAC9B,MAAM,WAAW,GAAG,WAAW,CAAC,KAAK,IAAI,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACrE,MAAM,gBAAgB,GAAG,CAAC,QAAQ,IAAI,QAAQ,KAAK,IAAI,CAAC,QAAQ,CAAC;QACjE,IAAI,WAAW,IAAI,gBAAgB,EAAE;YACnC,IAAI,GAAG,WAAW,CAAC;SACpB;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,IAAI,IAAI,IAAI,EAAE;QAChB,OAAO,EAAE,CAAC;KACX;IAED,IAAI,SAAS,CAAC;IACd,IAAI,MAAM,EAAE;QACV,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;KACxC;SAAM;QACL,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/C,SAAS,GAAG,IAAI,CAAC,iBAAiB,CAAC,CAAC;KACrC;IAED,OAAO;QACL,SAAS;QACT,MAAM;QACN,QAAQ;KACT,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,gBAAwB,EAAE,EAAE;IAC5D,MAAM,WAAW,GAAG,gCAAgC,CAAC;IACrD,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,EAAE,CAAC;IACxC,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAE/C,MAAM,kBAAkB,GAAG,WAAW;QACpC,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC,CAAC;IACN,MAAM,gBAAgB,GAAG,WAAW;QAClC,CAAC,CAAC,kBAAkB,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC;QAChD,CAAC,CAAC,CAAC,CAAC;IAEN,MAAM,QAAQ,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAAC,IAAI,EAAE,CAAC;IAE1E,OAAO;QACL,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS;QAC3E,QAAQ,EAAE,gBAAgB,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC,IAAI,EAAE;QAC7D,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;KAC1C,CAAC;AACJ,CAAC,CAAC;AAEF,SAAS,yBAAyB,CAAC,IAAY;IAC7C,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;QACxB,OAAO,IAAI,CAAC;KACb;IACD,OAAO,GAAG,GAAG,IAAI,CAAC;AACpB,CAAC;AAED,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,EAAE;IAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAChC,IAAI,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,oBAAoB;IACzF,YAAY,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,yBAAyB;IAC3E,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,yBAAyB;IACtG,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC;AAEF,eAAe,UAAU,CAAC"}
|
package/bin/util.js
CHANGED
|
@@ -1,6 +1,4 @@
|
|
|
1
|
-
import { mkdirSync, writeFileSync } from "fs";
|
|
2
1
|
import Ora from "ora";
|
|
3
|
-
import path from "path";
|
|
4
2
|
import shell from "shelljs";
|
|
5
3
|
export const MintConfig = (name, color, ctaName, ctaUrl, filename) => {
|
|
6
4
|
return {
|
|
@@ -66,34 +64,6 @@ export const addMdx = (fileName) => {
|
|
|
66
64
|
}
|
|
67
65
|
return fileName + ".mdx";
|
|
68
66
|
};
|
|
69
|
-
export const createPage = (title, description, markdown, overwrite = false, rootDir = "", fileName) => {
|
|
70
|
-
const writePath = path.join(rootDir, addMdx(fileName || toFilename(title)));
|
|
71
|
-
// Create the folders needed if they're missing
|
|
72
|
-
mkdirSync(rootDir, { recursive: true });
|
|
73
|
-
// Write the page to memory
|
|
74
|
-
if (overwrite) {
|
|
75
|
-
writeFileSync(writePath, Page(title, description, markdown));
|
|
76
|
-
console.log("✏️ - " + writePath);
|
|
77
|
-
}
|
|
78
|
-
else {
|
|
79
|
-
try {
|
|
80
|
-
writeFileSync(writePath, Page(title, description, markdown), {
|
|
81
|
-
flag: "wx",
|
|
82
|
-
});
|
|
83
|
-
console.log("✏️ - " + writePath);
|
|
84
|
-
}
|
|
85
|
-
catch (e) {
|
|
86
|
-
// We do a try-catch instead of an if-statement to avoid a race condition
|
|
87
|
-
// of the file being created after we started writing.
|
|
88
|
-
if (e.code === "EEXIST") {
|
|
89
|
-
console.log(`❌ Skipping existing file ${writePath}`);
|
|
90
|
-
}
|
|
91
|
-
else {
|
|
92
|
-
console.error(e);
|
|
93
|
-
}
|
|
94
|
-
}
|
|
95
|
-
}
|
|
96
|
-
};
|
|
97
67
|
export const buildLogger = (startText = "") => {
|
|
98
68
|
const logger = Ora().start(startText);
|
|
99
69
|
return logger;
|
package/bin/util.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AACA,OAAO,GAAuB,MAAM,KAAK,CAAC;AAE1C,OAAO,KAAK,MAAM,SAAS,CAAC;AAE5B,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,IAAY,EACZ,KAAa,EACb,OAAe,EACf,MAAc,EACd,QAAgB,EAChB,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,QAAQ,CAAC;aAClB;SACF;QACD,6DAA6D;KAC9D,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAG,CAClB,KAAa,EACb,WAAoB,EACpB,QAAiB,EACjB,EAAE;IACF,uDAAuD;IACvD,yDAAyD;IACzD,wBAAwB;IACxB,MAAM,eAAe,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAC9C,MAAM,aAAa,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAC5C,IAAI,CAAC,eAAe,EAAE;QACpB,KAAK,GAAG,GAAG,GAAG,KAAK,CAAC;KACrB;IACD,IAAI,CAAC,aAAa,EAAE;QAClB,KAAK,GAAG,KAAK,GAAG,GAAG,CAAC;KACrB;IAED,MAAM,mBAAmB,GAAG,WAAW;QACrC,CAAC,CAAC,mBAAmB,WAAW,GAAG;QACnC,CAAC,CAAC,EAAE,CAAC;IACP,OAAO,eAAe,KAAK,GAAG,mBAAmB,YAAY,QAAQ,EAAE,CAAC;AAC1E,CAAC,CAAC;AAEF,MAAM,UAAU,SAAS,CAAC,GAAW;IACnC,+CAA+C;IAC/C,gDAAgD;IAChD,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;AAC7B,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,IAA2B;IAC7D,4BAA4B;IAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACrE,CAAC;AAED,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,EAAE;IAC1C,sDAAsD;IACtD,uDAAuD;IACvD,OAAO,KAAK;SACT,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;SAC3B,IAAI,EAAE;SACN,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC;SAClB,WAAW,EAAE,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,QAAgB,EAAE,EAAE;IACzC,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;QAC7B,OAAO,QAAQ,CAAC;KACjB;IACD,OAAO,QAAQ,GAAG,MAAM,CAAC;AAC3B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,SAAS,GAAG,EAAE,EAAW,EAAE;IACrD,MAAM,MAAM,GAAG,GAAG,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACtC,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,QAAgB,EAAE,EAAE;IACnD,MAAM,GAAG,GAAG,QAAQ,CAAC,SAAS,CAC5B,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAC7B,QAAQ,CAAC,MAAM,CAChB,CAAC;IACF,IAAI,QAAQ,KAAK,GAAG;QAAE,OAAO,SAAS,CAAC;IACvC,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,QAAgB,EAAE,EAAE;IAC3D,MAAM,SAAS,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAC7C,OAAO,CACL,SAAS;QACT,CAAC,SAAS,KAAK,KAAK,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,KAAK,CAAC,CACnE,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,MAAe,EAAE,EAAE;IAC5C,MAAM,aAAa,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC1C,IAAI,CAAC,aAAa,EAAE;QAClB,MAAM,CAAC,IAAI,CAAC;;;;KAIX,CAAC,CAAC;QACH,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;AACH,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mintlify/previewing",
|
|
3
|
-
"version": "3.0.
|
|
3
|
+
"version": "3.0.2",
|
|
4
4
|
"description": "Preview Mintlify docs locally",
|
|
5
5
|
"engines": {
|
|
6
6
|
"node": ">=18.0.0"
|
|
@@ -33,20 +33,15 @@
|
|
|
33
33
|
"@octokit/rest": "^19.0.5",
|
|
34
34
|
"axios": "^1.2.2",
|
|
35
35
|
"chalk": "^5.1.0",
|
|
36
|
-
"cheerio": "^0.22.0",
|
|
37
36
|
"chokidar": "^3.5.3",
|
|
38
|
-
"favicons": "^7.0.1",
|
|
39
37
|
"fs-extra": "^11.1.0",
|
|
40
38
|
"gray-matter": "^4.0.3",
|
|
41
39
|
"inquirer": "^9.1.0",
|
|
42
40
|
"is-absolute-url": "^4.0.1",
|
|
43
41
|
"is-internet-available": "^3.1.0",
|
|
44
|
-
"minimist-lite": "^2.2.1",
|
|
45
|
-
"node-html-markdown": "^1.3.0",
|
|
46
42
|
"open": "^8.4.0",
|
|
47
43
|
"openapi-types": "^12.0.2",
|
|
48
44
|
"ora": "^6.1.2",
|
|
49
|
-
"puppeteer": "^19.4.0",
|
|
50
45
|
"remark": "^14.0.2",
|
|
51
46
|
"remark-frontmatter": "^4.0.1",
|
|
52
47
|
"remark-gfm": "^3.0.1",
|
|
@@ -60,7 +55,6 @@
|
|
|
60
55
|
"@mintlify/eslint-config-typescript": "1.0.7",
|
|
61
56
|
"@mintlify/ts-config": "1.0.7",
|
|
62
57
|
"@tsconfig/recommended": "1.x",
|
|
63
|
-
"@types/cheerio": "^0.22.31",
|
|
64
58
|
"@types/fs-extra": "^9.0.13",
|
|
65
59
|
"@types/inquirer": "^9.0.1",
|
|
66
60
|
"@types/node": "^18.7.13",
|
package/src/index.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable @typescript-eslint/no-empty-function */
|
|
3
3
|
|
|
4
4
|
import yargs from "yargs";
|
|
5
|
-
import { hideBin } from "yargs/helpers
|
|
5
|
+
import { hideBin } from "yargs/helpers";
|
|
6
6
|
import dev from "./local-preview/index.js";
|
|
7
7
|
import installDepsCommand from "./local-preview/helper-commands/installDepsCommand.js";
|
|
8
8
|
|
|
@@ -23,14 +23,18 @@ const createPage = async (
|
|
|
23
23
|
// Replace .mdx so we can pass file paths into this function
|
|
24
24
|
const slug = pagePath.replace(/\.mdx?$/, "");
|
|
25
25
|
let defaultTitle = slugToTitle(slug);
|
|
26
|
+
let description: string;
|
|
26
27
|
// Append data from OpenAPI if it exists
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
);
|
|
28
|
+
if (metadata?.openapi) {
|
|
29
|
+
const { title, description: openApiDescription } =
|
|
30
|
+
getOpenApiTitleAndDescription(openApiFiles, metadata?.openapi);
|
|
31
31
|
|
|
32
|
-
|
|
33
|
-
|
|
32
|
+
if (title) {
|
|
33
|
+
defaultTitle = title;
|
|
34
|
+
}
|
|
35
|
+
if (openApiDescription) {
|
|
36
|
+
description = openApiDescription;
|
|
37
|
+
}
|
|
34
38
|
}
|
|
35
39
|
|
|
36
40
|
const pageMetadata = {
|
package/src/util.ts
CHANGED
|
@@ -84,41 +84,6 @@ export const addMdx = (fileName: string) => {
|
|
|
84
84
|
return fileName + ".mdx";
|
|
85
85
|
};
|
|
86
86
|
|
|
87
|
-
export const createPage = (
|
|
88
|
-
title: string,
|
|
89
|
-
description?: string,
|
|
90
|
-
markdown?: string,
|
|
91
|
-
overwrite = false,
|
|
92
|
-
rootDir = "",
|
|
93
|
-
fileName?: string
|
|
94
|
-
) => {
|
|
95
|
-
const writePath = path.join(rootDir, addMdx(fileName || toFilename(title)));
|
|
96
|
-
|
|
97
|
-
// Create the folders needed if they're missing
|
|
98
|
-
mkdirSync(rootDir, { recursive: true });
|
|
99
|
-
|
|
100
|
-
// Write the page to memory
|
|
101
|
-
if (overwrite) {
|
|
102
|
-
writeFileSync(writePath, Page(title, description, markdown));
|
|
103
|
-
console.log("✏️ - " + writePath);
|
|
104
|
-
} else {
|
|
105
|
-
try {
|
|
106
|
-
writeFileSync(writePath, Page(title, description, markdown), {
|
|
107
|
-
flag: "wx",
|
|
108
|
-
});
|
|
109
|
-
console.log("✏️ - " + writePath);
|
|
110
|
-
} catch (e) {
|
|
111
|
-
// We do a try-catch instead of an if-statement to avoid a race condition
|
|
112
|
-
// of the file being created after we started writing.
|
|
113
|
-
if (e.code === "EEXIST") {
|
|
114
|
-
console.log(`❌ Skipping existing file ${writePath}`);
|
|
115
|
-
} else {
|
|
116
|
-
console.error(e);
|
|
117
|
-
}
|
|
118
|
-
}
|
|
119
|
-
}
|
|
120
|
-
};
|
|
121
|
-
|
|
122
87
|
export const buildLogger = (startText = ""): OraType => {
|
|
123
88
|
const logger = Ora().start(startText);
|
|
124
89
|
return logger;
|