mintlify 1.0.5 → 1.0.7

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.
Files changed (56) hide show
  1. package/README.md +8 -0
  2. package/bin/browser.js +24 -0
  3. package/bin/browser.js.map +1 -0
  4. package/bin/downloadImage.js +27 -0
  5. package/bin/downloadImage.js.map +1 -0
  6. package/bin/index.js +147 -15
  7. package/bin/index.js.map +1 -1
  8. package/bin/scraping/detectFramework.js +25 -0
  9. package/bin/scraping/detectFramework.js.map +1 -0
  10. package/bin/scraping/downloadAllImages.js +57 -0
  11. package/bin/scraping/downloadAllImages.js.map +1 -0
  12. package/bin/scraping/getSitemapLinks.js +16 -0
  13. package/bin/scraping/getSitemapLinks.js.map +1 -0
  14. package/bin/scraping/replaceImagePaths.js +17 -0
  15. package/bin/scraping/replaceImagePaths.js.map +1 -0
  16. package/bin/scraping/scrapeGettingFileNameFromUrl.js +43 -0
  17. package/bin/scraping/scrapeGettingFileNameFromUrl.js.map +1 -0
  18. package/bin/scraping/scrapePage.js +9 -0
  19. package/bin/scraping/scrapePage.js.map +1 -0
  20. package/bin/scraping/scrapeSection.js +9 -0
  21. package/bin/scraping/scrapeSection.js.map +1 -0
  22. package/bin/scraping/site-scrapers/scrapeDocusaurusPage.js +43 -0
  23. package/bin/scraping/site-scrapers/scrapeDocusaurusPage.js.map +1 -0
  24. package/bin/scraping/site-scrapers/scrapeDocusaurusSection.js +52 -0
  25. package/bin/scraping/site-scrapers/scrapeDocusaurusSection.js.map +1 -0
  26. package/bin/{scrapeGitBook.js → scraping/site-scrapers/scrapeGitBookPage.js} +11 -6
  27. package/bin/scraping/site-scrapers/scrapeGitBookPage.js.map +1 -0
  28. package/bin/scraping/site-scrapers/scrapeGitBookSection.js +74 -0
  29. package/bin/scraping/site-scrapers/scrapeGitBookSection.js.map +1 -0
  30. package/bin/{scrapeReadMe.js → scraping/site-scrapers/scrapeReadMePage.js} +16 -10
  31. package/bin/scraping/site-scrapers/scrapeReadMePage.js.map +1 -0
  32. package/bin/scraping/site-scrapers/scrapeReadMeSection.js +48 -0
  33. package/bin/scraping/site-scrapers/scrapeReadMeSection.js.map +1 -0
  34. package/bin/util.js +44 -3
  35. package/bin/util.js.map +1 -1
  36. package/package.json +3 -2
  37. package/src/browser.ts +24 -0
  38. package/src/downloadImage.ts +35 -0
  39. package/src/index.ts +177 -15
  40. package/src/scraping/detectFramework.ts +31 -0
  41. package/src/scraping/downloadAllImages.ts +79 -0
  42. package/src/scraping/getSitemapLinks.ts +16 -0
  43. package/src/scraping/replaceImagePaths.ts +21 -0
  44. package/src/scraping/scrapeGettingFileNameFromUrl.ts +81 -0
  45. package/src/scraping/scrapePage.ts +24 -0
  46. package/src/scraping/scrapeSection.ts +16 -0
  47. package/src/scraping/site-scrapers/scrapeDocusaurusPage.ts +67 -0
  48. package/src/scraping/site-scrapers/scrapeDocusaurusSection.ts +80 -0
  49. package/src/{scrapeGitBook.ts → scraping/site-scrapers/scrapeGitBookPage.ts} +25 -5
  50. package/src/scraping/site-scrapers/scrapeGitBookSection.ts +116 -0
  51. package/src/{scrapeReadMe.ts → scraping/site-scrapers/scrapeReadMePage.ts} +28 -10
  52. package/src/scraping/site-scrapers/scrapeReadMeSection.ts +77 -0
  53. package/src/util.ts +48 -6
  54. package/tsconfig.json +1 -1
  55. package/bin/scrapeGitBook.js.map +0 -1
  56. package/bin/scrapeReadMe.js.map +0 -1
package/src/util.ts CHANGED
@@ -1,6 +1,18 @@
1
- import { writeFileSync } from "fs";
1
+ import { mkdirSync, writeFileSync } from "fs";
2
+ import path from "path";
2
3
  import { Page } from "./templates.js";
3
4
 
5
+ export function getOrigin(url: string) {
6
+ // eg. https://google.com -> https://google.com
7
+ // https://google.com/page -> https://google.com
8
+ return new URL(url).origin;
9
+ }
10
+
11
+ export function objToReadableString(objs: Object[]) {
12
+ // Two spaces as indentation
13
+ return objs.map((obj) => JSON.stringify(obj, null, 2)).join(",\n");
14
+ }
15
+
4
16
  export const toFilename = (title: string) => {
5
17
  // Gets rid of special characters at the start and end
6
18
  // of the name by converting to spaces then using trim.
@@ -11,14 +23,44 @@ export const toFilename = (title: string) => {
11
23
  .toLowerCase();
12
24
  };
13
25
 
26
+ export const addMdx = (fileName: string) => {
27
+ if (fileName.endsWith(".mdx")) {
28
+ return fileName;
29
+ }
30
+ return fileName + ".mdx";
31
+ };
32
+
14
33
  export const createPage = (
15
34
  title: string,
16
35
  description?: string,
17
36
  markdown?: string,
18
- rootDir: string = ""
37
+ overwrite: boolean = false,
38
+ rootDir: string = "",
39
+ fileName?: string
19
40
  ) => {
20
- return writeFileSync(
21
- rootDir + toFilename(title) + ".mdx",
22
- Page(title, description, markdown)
23
- );
41
+ const writePath = path.join(rootDir, addMdx(fileName || toFilename(title)));
42
+
43
+ // Create the folders needed if they're missing
44
+ mkdirSync(rootDir, { recursive: true });
45
+
46
+ // Write the page to memory
47
+ if (overwrite) {
48
+ writeFileSync(writePath, Page(title, description, markdown));
49
+ console.log("✏️ - " + writePath);
50
+ } else {
51
+ try {
52
+ writeFileSync(writePath, Page(title, description, markdown), {
53
+ flag: "wx",
54
+ });
55
+ console.log("✏️ - " + writePath);
56
+ } catch (e) {
57
+ // We do a try-catch instead of an if-statement to avoid a race condition
58
+ // of the file being created after we started writing.
59
+ if (e.code === "EEXIST") {
60
+ console.log(`❌ Skipping existing file ${writePath}`);
61
+ } else {
62
+ console.error(e);
63
+ }
64
+ }
65
+ }
24
66
  };
package/tsconfig.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "module": "node16",
4
4
  "moduleResolution": "node16",
5
5
  "target": "es2017",
6
- "lib": ["es2016", "dom"],
6
+ "lib": ["es2016", "dom", "ES2021.String"],
7
7
  "sourceMap": true,
8
8
  "outDir": "bin",
9
9
  "baseUrl": ".",
@@ -1 +0,0 @@
1
- {"version":3,"file":"scrapeGitBook.js","sourceRoot":"","sources":["../src/scrapeGitBook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,GAAW;IAC7C,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACzC,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAEjC,MAAM,cAAc,GAAG,CAAC,CAAC,4BAA4B,CAAC,CAAC,KAAK,EAAE,CAAC;IAC/D,MAAM,mBAAmB,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC;IAC7E,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;IACjC,MAAM,WAAW,GAAG,mBAAmB;SACpC,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC;SAClC,IAAI,EAAE,CAAC;IACV,MAAM,KAAK,GAAG,cAAc,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC;IAE3C,MAAM,OAAO,GAAG,CAAC,CAAC,oCAAoC,CAAC,CAAC,KAAK,EAAE,CAAC;IAChE,MAAM,WAAW,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAEpC,MAAM,GAAG,GAAG,IAAI,gBAAgB,EAAE,CAAC;IACnC,IAAI,QAAQ,GAAG,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;IAE1C,2DAA2D;IAC3D,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAE9C,qDAAqD;IACrD,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IAE3C,iCAAiC;IACjC,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAE/C,gEAAgE;IAChE,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;IAEjE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC;AAC1C,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"scrapeReadMe.js","sourceRoot":"","sources":["../src/scrapeReadMe.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,GAAW;IAC5C,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACzC,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAEjC,MAAM,cAAc,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;IACvC,MAAM,KAAK,GAAG,cAAc,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC;IAC3C,MAAM,WAAW,GAAG,CAAC,CAAC,gBAAgB,EAAE,cAAc,CAAC,MAAM,EAAE,CAAC;SAC7D,IAAI,EAAE;SACN,IAAI,EAAE,CAAC;IAEV,MAAM,OAAO,GAAG,CAAC,CAAC,8BAA8B,CAAC,CAAC,KAAK,EAAE,CAAC;IAC1D,MAAM,WAAW,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAEpC,MAAM,GAAG,GAAG,IAAI,gBAAgB,EAAE,CAAC;IACnC,IAAI,QAAQ,GAAG,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;IAE1C,2DAA2D;IAC3D,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAE9C,qDAAqD;IACrD,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IAE3C,6BAA6B;IAC7B,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAC;IAEtD,iCAAiC;IACjC,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAE/C,gEAAgE;IAChE,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;IAEjE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC;AAC1C,CAAC"}