@mintlify/previewing 3.1.0 → 3.1.1
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/README.md +8 -69
- package/dist/local-preview/listener/categorize.js +3 -2
- package/dist/local-preview/listener/categorize.js.map +1 -1
- package/dist/local-preview/listener/utils.d.ts +0 -1
- package/dist/local-preview/listener/utils.js +0 -15
- package/dist/local-preview/listener/utils.js.map +1 -1
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -1,78 +1,17 @@
|
|
|
1
|
-
|
|
2
|
-
<a href="https://mintlify.com">
|
|
3
|
-
<img
|
|
4
|
-
src="https://res.cloudinary.com/mintlify/image/upload/v1665385627/logo-rounded_zuk7q1.svg"
|
|
5
|
-
alt="Mintlify Logo"
|
|
6
|
-
height="64"
|
|
7
|
-
/>
|
|
8
|
-
</a>
|
|
9
|
-
<br />
|
|
10
|
-
<p>
|
|
11
|
-
<h3>
|
|
12
|
-
<b>
|
|
13
|
-
Mintlify CLI
|
|
14
|
-
</b>
|
|
15
|
-
</h3>
|
|
16
|
-
</p>
|
|
17
|
-
<p>
|
|
18
|
-
The Mintlify CLI is the easiest way to build Mintlify apps from the command line.
|
|
19
|
-
</p>
|
|
20
|
-
<p>
|
|
1
|
+
# @mintlify/previewing
|
|
21
2
|
|
|
22
|
-
|
|
3
|
+
Preview Mintlify docs locally.
|
|
23
4
|
|
|
24
|
-
|
|
25
|
-
<p>
|
|
26
|
-
<sub>
|
|
27
|
-
Built with ❤︎ by
|
|
28
|
-
<a href="https://mintlify.com">
|
|
29
|
-
Mintlify
|
|
30
|
-
</a>
|
|
31
|
-
</sub>
|
|
32
|
-
</p>
|
|
33
|
-
</div>
|
|
34
|
-
|
|
35
|
-
### 🚀 Installation
|
|
36
|
-
|
|
37
|
-
Download the Mintlify CLI using the following command
|
|
38
|
-
|
|
39
|
-
```
|
|
40
|
-
npm i -g mintlify
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
### 👩💻 Development
|
|
44
|
-
|
|
45
|
-
Run the following command at the root of your Mintlify application to preview changes locally.
|
|
46
|
-
|
|
47
|
-
```
|
|
48
|
-
mintlify dev
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
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.
|
|
52
|
-
|
|
53
|
-
### Custom Ports
|
|
54
|
-
|
|
55
|
-
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:
|
|
5
|
+
## 🚀 Installation
|
|
56
6
|
|
|
57
7
|
```
|
|
58
|
-
|
|
8
|
+
npm install @mintlify/previewing
|
|
59
9
|
```
|
|
60
10
|
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
```
|
|
64
|
-
Error: listen EADDRINUSE: address already in use :::3000
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
#### Troubleshooting
|
|
68
|
-
|
|
69
|
-
Steps you can take if the dev CLI is not working (After each step try to run `mintlify dev` again):
|
|
11
|
+
## Community
|
|
70
12
|
|
|
71
|
-
|
|
72
|
-
- Make sure you are using Node v18 or higher.
|
|
73
|
-
- Run `mintlify install` to re-install dependencies.
|
|
74
|
-
- Navigate to the `.mintlify` folder in your home directory and delete its contents.
|
|
13
|
+
Join our Discord community if you have questions or just want to chat:
|
|
75
14
|
|
|
76
|
-
|
|
15
|
+
[](https://discord.gg/ACREKdwjG5)
|
|
77
16
|
|
|
78
|
-
|
|
17
|
+
_Built with 💚 by the Mintlify community._
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
// TODO - put in prebuild package
|
|
2
2
|
import path from "path";
|
|
3
|
-
import {
|
|
3
|
+
import { getFileList } from "@mintlify/prebuild";
|
|
4
|
+
import { getFileExtension, openApiCheck } from "./utils.js";
|
|
4
5
|
export const categorizeFiles = async (contentDirectoryPath) => {
|
|
5
|
-
const allFilesInCmdExecutionPath =
|
|
6
|
+
const allFilesInCmdExecutionPath = getFileList(contentDirectoryPath);
|
|
6
7
|
const contentFilenames = [];
|
|
7
8
|
const staticFilenames = [];
|
|
8
9
|
const promises = [];
|
|
@@ -1 +1 @@
|
|
|
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,
|
|
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,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAG5D,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,EAAE,oBAA4B,EAAE,EAAE;IACpE,MAAM,0BAA0B,GAC9B,WAAW,CAAC,oBAAoB,CAAC,CAAC;IACpC,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"}
|
|
@@ -9,6 +9,5 @@ export declare const filterOutNullInGroup: (group: MintNavigation) => {
|
|
|
9
9
|
group: string;
|
|
10
10
|
version?: string;
|
|
11
11
|
};
|
|
12
|
-
export declare const getFileList: (dirName: string, og?: string) => Promise<string[]>;
|
|
13
12
|
export declare const isFileSizeValid: (path: string, maxFileSizeInMb: number) => Promise<boolean>;
|
|
14
13
|
export declare function isError(obj: unknown): boolean;
|
|
@@ -42,21 +42,6 @@ const filterOutNullInPages = (pages) => {
|
|
|
42
42
|
});
|
|
43
43
|
return newPages;
|
|
44
44
|
};
|
|
45
|
-
export const getFileList = async (dirName, og = dirName) => {
|
|
46
|
-
let files = [];
|
|
47
|
-
const items = await readdir(dirName, { withFileTypes: true });
|
|
48
|
-
for (const item of items) {
|
|
49
|
-
if (item.isDirectory()) {
|
|
50
|
-
files = [...files, ...(await getFileList(`${dirName}/${item.name}`, og))];
|
|
51
|
-
}
|
|
52
|
-
else {
|
|
53
|
-
const path = `${dirName}/${item.name}`;
|
|
54
|
-
const name = path.replace(og, "");
|
|
55
|
-
files.push(name);
|
|
56
|
-
}
|
|
57
|
-
}
|
|
58
|
-
return files;
|
|
59
|
-
};
|
|
60
45
|
export const isFileSizeValid = async (path, maxFileSizeInMb) => {
|
|
61
46
|
const maxFileSizeBytes = maxFileSizeInMb * 1000000;
|
|
62
47
|
const stats = await stat(path);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/local-preview/listener/utils.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,6BAA6B,CAAC;AACxD,OAAO,EAAE,QAAQ,IAAI,SAAS,EAAE,MAAM,IAAI,CAAC;AAE3C,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC;AAEpC,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,QAAgB,EAAE,EAAE;IACnD,OAAO,CACL,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC;QAClE,QAAQ,CACT,CAAC;AACJ,CAAC,CAAC;AAOF,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAC/B,IAAY,EACiB,EAAE;IAC/B,IAAI,IAAI,CAAC;IACT,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,IAAI;QACF,IAAI,GAAG,MAAM,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC1C,SAAS,GAAG,IAAI,CAAC;KAClB;IAAC,MAAM;QACN,oBAAoB;KACrB;IACD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;AAC7B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,KAAqB,EAAE,EAAE;IAC5D,MAAM,QAAQ,GAAG,oBAAoB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACnD,MAAM,QAAQ,GAAG;QACf,GAAG,KAAK;QACR,KAAK,EAAE,QAAQ;KAChB,CAAC;IACF,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,KAAqC,EAAE,EAAE;IACrE,MAAM,QAAQ,GAA0B,EAAE,CAAC;IAC3C,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACrB,IAAI,IAAI,IAAI,IAAI,EAAE;YAChB,OAAO;SACR;QACD,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE;YAChC,MAAM,KAAK,GAAG,IAAsB,CAAC;YACrC,MAAM,QAAQ,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;YAC7C,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACzB;aAAM;YACL,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACrB;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,
|
|
1
|
+
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/local-preview/listener/utils.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,6BAA6B,CAAC;AACxD,OAAO,EAAE,QAAQ,IAAI,SAAS,EAAE,MAAM,IAAI,CAAC;AAE3C,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC;AAEpC,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,QAAgB,EAAE,EAAE;IACnD,OAAO,CACL,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC;QAClE,QAAQ,CACT,CAAC;AACJ,CAAC,CAAC;AAOF,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAC/B,IAAY,EACiB,EAAE;IAC/B,IAAI,IAAI,CAAC;IACT,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,IAAI;QACF,IAAI,GAAG,MAAM,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC1C,SAAS,GAAG,IAAI,CAAC;KAClB;IAAC,MAAM;QACN,oBAAoB;KACrB;IACD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;AAC7B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,KAAqB,EAAE,EAAE;IAC5D,MAAM,QAAQ,GAAG,oBAAoB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACnD,MAAM,QAAQ,GAAG;QACf,GAAG,KAAK;QACR,KAAK,EAAE,QAAQ;KAChB,CAAC;IACF,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,KAAqC,EAAE,EAAE;IACrE,MAAM,QAAQ,GAA0B,EAAE,CAAC;IAC3C,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACrB,IAAI,IAAI,IAAI,IAAI,EAAE;YAChB,OAAO;SACR;QACD,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE;YAChC,MAAM,KAAK,GAAG,IAAsB,CAAC;YACrC,MAAM,QAAQ,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;YAC7C,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACzB;aAAM;YACL,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACrB;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,EAClC,IAAY,EACZ,eAAuB,EACL,EAAE;IACpB,MAAM,gBAAgB,GAAG,eAAe,GAAG,OAAO,CAAC;IACnD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,OAAO,KAAK,CAAC,IAAI,IAAI,gBAAgB,CAAC;AACxC,CAAC,CAAC;AAEF,MAAM,UAAU,OAAO,CAAC,GAAY;IAClC,OAAO,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,gBAAgB,CAAC;AAClE,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mintlify/previewing",
|
|
3
|
-
"version": "3.1.
|
|
3
|
+
"version": "3.1.1",
|
|
4
4
|
"description": "Preview Mintlify docs locally",
|
|
5
5
|
"engines": {
|
|
6
6
|
"node": ">=18.0.0"
|
|
@@ -38,6 +38,7 @@
|
|
|
38
38
|
},
|
|
39
39
|
"dependencies": {
|
|
40
40
|
"@apidevtools/swagger-parser": "^10.1.0",
|
|
41
|
+
"@mintlify/prebuild": "^1.0.0",
|
|
41
42
|
"@mintlify/validation": "^0.1.9",
|
|
42
43
|
"@octokit/rest": "^19.0.5",
|
|
43
44
|
"axios": "^1.2.2",
|