mintlify 1.1.7 → 1.1.9

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 (174) hide show
  1. package/README.md +0 -1
  2. package/bin/constants.js +0 -1
  3. package/bin/constants.js.map +1 -1
  4. package/bin/index.js +0 -2
  5. package/bin/index.js.map +1 -1
  6. package/bin/local-preview/helper-commands/cleanCommand.js +8 -0
  7. package/bin/local-preview/helper-commands/cleanCommand.js.map +1 -0
  8. package/bin/local-preview/index.js +1 -17
  9. package/bin/local-preview/index.js.map +1 -1
  10. package/bin/scraping/scrapeSectionCommands.js +2 -5
  11. package/bin/scraping/scrapeSectionCommands.js.map +1 -1
  12. package/bin/scraping/site-scrapers/scrapeGitBookSection.js +4 -2
  13. package/bin/scraping/site-scrapers/scrapeGitBookSection.js.map +1 -1
  14. package/package.json +1 -1
  15. package/src/constants.ts +0 -5
  16. package/src/index.ts +0 -9
  17. package/src/local-preview/index.ts +0 -22
  18. package/src/scraping/scrapeSectionCommands.ts +2 -5
  19. package/src/scraping/site-scrapers/scrapeGitBookSection.ts +4 -2
  20. package/bin/local-preview/injectNav.js +0 -94
  21. package/bin/local-preview/injectNav.js.map +0 -1
  22. package/bin/mint/client/.babel-plugin-macrosrc.json +0 -5
  23. package/bin/mint/client/.babelrc +0 -4
  24. package/bin/mint/client/.editorconfig +0 -12
  25. package/bin/mint/client/.eslintrc.json +0 -7
  26. package/bin/mint/client/.prettierignore +0 -4
  27. package/bin/mint/client/.prettierrc +0 -14
  28. package/bin/mint/client/.vscode/launch.json +0 -28
  29. package/bin/mint/client/README.md +0 -44
  30. package/bin/mint/client/jest.config.ts +0 -195
  31. package/bin/mint/client/next-env.d.ts +0 -4
  32. package/bin/mint/client/next.config.js +0 -152
  33. package/bin/mint/client/package.json +0 -139
  34. package/bin/mint/client/postcss.config.cjs +0 -9
  35. package/bin/mint/client/prebuild/faviconConfig.js +0 -35
  36. package/bin/mint/client/prebuild/getOpenApiContext.js +0 -53
  37. package/bin/mint/client/prebuild/index.js +0 -117
  38. package/bin/mint/client/prebuild/injectNav.js +0 -115
  39. package/bin/mint/client/prebuild/slugToTitle.js +0 -7
  40. package/bin/mint/client/rehype/withApiComponents.js +0 -60
  41. package/bin/mint/client/rehype/withCodeBlocks.js +0 -54
  42. package/bin/mint/client/rehype/withLayouts.js +0 -113
  43. package/bin/mint/client/rehype/withLinkRoles.js +0 -13
  44. package/bin/mint/client/rehype/withRawComponents.js +0 -13
  45. package/bin/mint/client/rehype/withStaticProps.js +0 -25
  46. package/bin/mint/client/rehype/withSyntaxHighlighting.js +0 -60
  47. package/bin/mint/client/remark/utils.js +0 -369
  48. package/bin/mint/client/remark/withFrames.js +0 -55
  49. package/bin/mint/client/remark/withImportsInjected.js +0 -36
  50. package/bin/mint/client/remark/withNextLinks.js +0 -37
  51. package/bin/mint/client/remark/withTableOfContents.js +0 -71
  52. package/bin/mint/client/scripts/local.js +0 -177
  53. package/bin/mint/client/sentry.client.config.js +0 -15
  54. package/bin/mint/client/sentry.properties +0 -4
  55. package/bin/mint/client/sentry.server.config.js +0 -15
  56. package/bin/mint/client/src/analytics/AbstractAnalyticsImplementation.ts +0 -50
  57. package/bin/mint/client/src/analytics/AnalyticsContext.ts +0 -5
  58. package/bin/mint/client/src/analytics/AnalyticsMediator.ts +0 -101
  59. package/bin/mint/client/src/analytics/FakeAnalyticsMediator.ts +0 -9
  60. package/bin/mint/client/src/analytics/GA4Script.tsx +0 -33
  61. package/bin/mint/client/src/analytics/implementations/amplitude.ts +0 -26
  62. package/bin/mint/client/src/analytics/implementations/fathom.ts +0 -38
  63. package/bin/mint/client/src/analytics/implementations/ga4.ts +0 -33
  64. package/bin/mint/client/src/analytics/implementations/hotjar.ts +0 -53
  65. package/bin/mint/client/src/analytics/implementations/mixpanel-browser.d.ts +0 -1
  66. package/bin/mint/client/src/analytics/implementations/mixpanel.ts +0 -52
  67. package/bin/mint/client/src/analytics/implementations/posthog.ts +0 -37
  68. package/bin/mint/client/src/components/Accordion/Accordion.tsx +0 -43
  69. package/bin/mint/client/src/components/Accordion/index.ts +0 -4
  70. package/bin/mint/client/src/components/ApiExample.tsx +0 -9
  71. package/bin/mint/client/src/components/Card.tsx +0 -51
  72. package/bin/mint/client/src/components/CodeGroup.tsx +0 -132
  73. package/bin/mint/client/src/components/Editor.tsx +0 -12
  74. package/bin/mint/client/src/components/Expandable.tsx +0 -40
  75. package/bin/mint/client/src/components/Heading.tsx +0 -84
  76. package/bin/mint/client/src/components/Param.tsx +0 -56
  77. package/bin/mint/client/src/components/Request.tsx +0 -19
  78. package/bin/mint/client/src/components/ResponseField.tsx +0 -33
  79. package/bin/mint/client/src/components/TabBar.tsx +0 -61
  80. package/bin/mint/client/src/config.ts +0 -115
  81. package/bin/mint/client/src/css/bar-of-progress.css +0 -10
  82. package/bin/mint/client/src/css/base.css +0 -29
  83. package/bin/mint/client/src/css/font-awesome.css +0 -7
  84. package/bin/mint/client/src/css/fonts.css +0 -44
  85. package/bin/mint/client/src/css/main.css +0 -11
  86. package/bin/mint/client/src/css/prism.css +0 -270
  87. package/bin/mint/client/src/css/utilities.css +0 -43
  88. package/bin/mint/client/src/enums/components.ts +0 -8
  89. package/bin/mint/client/src/fonts/FiraCode-VF.woff +0 -0
  90. package/bin/mint/client/src/fonts/FiraCode-VF.woff2 +0 -0
  91. package/bin/mint/client/src/fonts/IBMPlexMono-Regular.ttf +0 -0
  92. package/bin/mint/client/src/fonts/IBMPlexMono-SemiBold.ttf +0 -0
  93. package/bin/mint/client/src/fonts/Inter-italic-latin.var.woff2 +0 -0
  94. package/bin/mint/client/src/fonts/Inter-roman-latin.var.woff2 +0 -0
  95. package/bin/mint/client/src/fonts/Pally-Variable.ttf +0 -0
  96. package/bin/mint/client/src/fonts/SourceSansPro-Regular.otf +0 -0
  97. package/bin/mint/client/src/fonts/SourceSerifPro-Regular.ttf +0 -0
  98. package/bin/mint/client/src/fonts/Synonym-Variable.ttf +0 -0
  99. package/bin/mint/client/src/fonts/Ubuntu-Mono-bold.woff2 +0 -0
  100. package/bin/mint/client/src/fonts/generated/IBMPlexMono-Regular-subset.woff2 +0 -0
  101. package/bin/mint/client/src/fonts/generated/IBMPlexMono-Regular-subset.zopfli.woff +0 -0
  102. package/bin/mint/client/src/fonts/generated/IBMPlexMono-Regular.module.css +0 -11
  103. package/bin/mint/client/src/fonts/generated/IBMPlexMono-SemiBold-subset.woff2 +0 -0
  104. package/bin/mint/client/src/fonts/generated/IBMPlexMono-SemiBold-subset.zopfli.woff +0 -0
  105. package/bin/mint/client/src/fonts/generated/IBMPlexMono-SemiBold.module.css +0 -11
  106. package/bin/mint/client/src/fonts/generated/Pally-Variable-subset.woff2 +0 -0
  107. package/bin/mint/client/src/fonts/generated/Pally-Variable-subset.zopfli.woff +0 -0
  108. package/bin/mint/client/src/fonts/generated/Pally-Variable.module.css +0 -11
  109. package/bin/mint/client/src/fonts/generated/SourceSerifPro-Regular-subset.woff2 +0 -0
  110. package/bin/mint/client/src/fonts/generated/SourceSerifPro-Regular-subset.zopfli.woff +0 -0
  111. package/bin/mint/client/src/fonts/generated/SourceSerifPro-Regular.module.css +0 -11
  112. package/bin/mint/client/src/fonts/generated/Synonym-Variable-subset.woff2 +0 -0
  113. package/bin/mint/client/src/fonts/generated/Synonym-Variable-subset.zopfli.woff +0 -0
  114. package/bin/mint/client/src/fonts/generated/Synonym-Variable.module.css +0 -11
  115. package/bin/mint/client/src/fonts/generated/TenorSans-Regular-subset.woff2 +0 -0
  116. package/bin/mint/client/src/fonts/generated/TenorSans-Regular-subset.zopfli.woff +0 -0
  117. package/bin/mint/client/src/fonts/generated/TenorSans-Regular.module.css +0 -11
  118. package/bin/mint/client/src/hooks/useActionKey.ts +0 -20
  119. package/bin/mint/client/src/hooks/useIsomorphicLayoutEffect.ts +0 -3
  120. package/bin/mint/client/src/hooks/useMedia.ts +0 -27
  121. package/bin/mint/client/src/hooks/usePrevNext.ts +0 -34
  122. package/bin/mint/client/src/hooks/useTop.ts +0 -15
  123. package/bin/mint/client/src/icons/CopyToClipboard.tsx +0 -33
  124. package/bin/mint/client/src/index.d.ts +0 -1
  125. package/bin/mint/client/src/layouts/ApiSupplemental.tsx +0 -173
  126. package/bin/mint/client/src/layouts/ContentsLayout.tsx +0 -256
  127. package/bin/mint/client/src/layouts/DocumentationLayout.tsx +0 -44
  128. package/bin/mint/client/src/layouts/OpenApiContent.tsx +0 -301
  129. package/bin/mint/client/src/layouts/SidebarLayout.tsx +0 -412
  130. package/bin/mint/client/src/layouts/UserFeedback.tsx +0 -73
  131. package/bin/mint/client/src/layouts/getGroupsInDivision.ts +0 -25
  132. package/bin/mint/client/src/layouts/isPathInGroupPages.ts +0 -10
  133. package/bin/mint/client/src/metadata.ts +0 -58
  134. package/bin/mint/client/src/nav.json +0 -219
  135. package/bin/mint/client/src/openapi.ts +0 -3
  136. package/bin/mint/client/src/pages/404.tsx +0 -73
  137. package/bin/mint/client/src/pages/_app.tsx +0 -138
  138. package/bin/mint/client/src/pages/_document.tsx +0 -57
  139. package/bin/mint/client/src/pages/api/issue.ts +0 -10
  140. package/bin/mint/client/src/pages/api/name.ts +0 -8
  141. package/bin/mint/client/src/pages/api/request.ts +0 -31
  142. package/bin/mint/client/src/pages/api/suggest.ts +0 -10
  143. package/bin/mint/client/src/pages/api/syntax-highlighted-json.ts +0 -13
  144. package/bin/mint/client/src/pages/api/utils.ts +0 -6
  145. package/bin/mint/client/src/pages/index.tsx +0 -31
  146. package/bin/mint/client/src/ui/Api.tsx +0 -359
  147. package/bin/mint/client/src/ui/Footer.tsx +0 -124
  148. package/bin/mint/client/src/ui/Header.tsx +0 -370
  149. package/bin/mint/client/src/ui/Logo.tsx +0 -55
  150. package/bin/mint/client/src/ui/PageHeader.tsx +0 -51
  151. package/bin/mint/client/src/ui/Search.tsx +0 -386
  152. package/bin/mint/client/src/ui/ThemeToggle.tsx +0 -285
  153. package/bin/mint/client/src/ui/Title.tsx +0 -22
  154. package/bin/mint/client/src/ui/TopLevelLink.tsx +0 -122
  155. package/bin/mint/client/src/utils/api.ts +0 -252
  156. package/bin/mint/client/src/utils/brands.ts +0 -217
  157. package/bin/mint/client/src/utils/castArray.ts +0 -3
  158. package/bin/mint/client/src/utils/childrenArray.ts +0 -3
  159. package/bin/mint/client/src/utils/fit.ts +0 -27
  160. package/bin/mint/client/src/utils/fontAwesome.ts +0 -577
  161. package/bin/mint/client/src/utils/getAnalyticsConfig.ts +0 -14
  162. package/bin/mint/client/src/utils/getLogoHref.ts +0 -9
  163. package/bin/mint/client/src/utils/getOpenApiContext.ts +0 -26
  164. package/bin/mint/client/src/utils/importAll.ts +0 -6
  165. package/bin/mint/client/src/utils/isObject.ts +0 -3
  166. package/bin/mint/client/src/utils/kebabToTitleCase.ts +0 -3
  167. package/bin/mint/client/src/utils/loadImage.ts +0 -8
  168. package/bin/mint/client/src/utils/slugToTitle.ts +0 -7
  169. package/bin/mint/client/src/utils/wait.ts +0 -5
  170. package/bin/mint/client/tailwind.config.cjs +0 -323
  171. package/bin/mint/client/test/test.test.ts +0 -5
  172. package/bin/mint/client/tsconfig.json +0 -36
  173. package/bin/mint/client/yarn.lock +0 -9702
  174. package/src/local-preview/helper-commands/clearCommand.ts +0 -33
package/README.md CHANGED
@@ -53,7 +53,6 @@ Note - `mintlify dev` requires `yarn` and it's recommended you install it as a g
53
53
  #### Troubleshooting
54
54
 
55
55
  - Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
56
- - Mintlify dev is updating really slowly - Run `mintlify clear` to clear the cache.
57
56
 
58
57
  ### 🏃 Get Started
59
58
 
package/bin/constants.js CHANGED
@@ -8,5 +8,4 @@ export const DOT_MINTLIFY = path.join(HOME_DIR, ".mintlify");
8
8
  export const CLIENT_PATH = path.join(DOT_MINTLIFY, "mint", "client");
9
9
  // command execution location
10
10
  export const CMD_EXEC_PATH = process.cwd();
11
- export const LAST_INVOCATION_PATH_FILE_LOCATION = path.join(CLIENT_PATH, "last-invocation-path");
12
11
  //# sourceMappingURL=constants.js.map
@@ -1 +1 @@
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,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,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;AAErE,6BAA6B;AAC7B,MAAM,CAAC,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;AAE3C,MAAM,CAAC,MAAM,kCAAkC,GAAG,IAAI,CAAC,IAAI,CACzD,WAAW,EACX,sBAAsB,CACvB,CAAC"}
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,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,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;AAErE,6BAA6B;AAC7B,MAAM,CAAC,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC"}
package/bin/index.js CHANGED
@@ -10,14 +10,12 @@ import { scrapeSectionAutomatically, scrapeSectionAxiosWrapper, scrapeGitbookSec
10
10
  import { scrapeReadMeSection } from "./scraping/site-scrapers/scrapeReadMeSection.js";
11
11
  import dev from "./local-preview/index.js";
12
12
  import installDepsCommand from "./local-preview/helper-commands/installDepsCommand.js";
13
- import clearCommand from "./local-preview/helper-commands/clearCommand.js";
14
13
  // TODO - add descriptions to the command options https://github.com/yargs/yargs/blob/HEAD/docs/api.md#commandmodule
15
14
  yargs(hideBin(process.argv))
16
15
  .command("dev", "Runs Mintlify locally (Must run in directory with mint.json)", () => { }, async () => {
17
16
  await dev();
18
17
  })
19
18
  .command("install", "Install dependencies for local Mintlify", () => { }, installDepsCommand)
20
- .command("clear", "Clear cache", () => { }, (args) => clearCommand(args))
21
19
  .command("init", "Generate a mintlify template", () => { }, initCommand)
22
20
  .command("page", "Generate a new page", () => { }, generatePageTemplate)
23
21
  .command("scrape-page [url]", "Scrapes a page", () => { }, async (argv) => {
package/bin/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,WAAW,MAAM,yBAAyB,CAAC;AAClD,OAAO,oBAAoB,MAAM,mBAAmB,CAAC;AACrD,OAAO,EACL,uBAAuB,EACvB,iBAAiB,GAClB,MAAM,kCAAkC,CAAC;AAE1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAClF,OAAO,EAAE,gBAAgB,EAAE,MAAM,8CAA8C,CAAC;AAChF,OAAO,EACL,0BAA0B,EAC1B,yBAAyB,EACzB,2BAA2B,GAE5B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,iDAAiD,CAAC;AACtF,OAAO,GAAG,MAAM,0BAA0B,CAAC;AAC3C,OAAO,kBAAkB,MAAM,uDAAuD,CAAC;AACvF,OAAO,YAAY,MAAM,iDAAiD,CAAC;AAE3E,oHAAoH;AACpH,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;KACzB,OAAO,CACN,KAAK,EACL,8DAA8D,EAC9D,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,IAAI,EAAE;IACT,MAAM,GAAG,EAAE,CAAC;AACd,CAAC,CACF;KACA,OAAO,CACN,SAAS,EACT,yCAAyC,EACzC,GAAG,EAAE,GAAE,CAAC,EACR,kBAAkB,CACnB;KACA,OAAO,CACN,OAAO,EACP,aAAa,EACb,GAAG,EAAE,GAAE,CAAC,EACR,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,CAC7B;KACA,OAAO,CAAC,MAAM,EAAE,8BAA8B,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,WAAW,CAAC;KACtE,OAAO,CAAC,MAAM,EAAE,qBAAqB,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,oBAAoB,CAAC;KACtE,OAAO,CACN,mBAAmB,EACnB,gBAAgB,EAChB,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,uBAAuB,CAAC,IAAI,CAAC,CAAC;AACtC,CAAC,CACF;KACA,OAAO,CACN,2BAA2B,EAC3B,wBAAwB,EACxB,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,iBAAiB,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;AACnD,CAAC,CACF;KACA,OAAO,CACN,0BAA0B,EAC1B,uBAAuB,EACvB,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,iBAAiB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;AAClD,CAAC,CACF;KACA,OAAO,CACN,sBAAsB,EACtB,iCAAiC,EACjC,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,0BAA0B,CAAC,IAAI,CAAC,CAAC;AACzC,CAAC,CACF;KACA,OAAO,CACN,8BAA8B,EAC9B,6BAA6B,EAC7B,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,2BAA2B,CAAC,IAAI,CAAC,CAAC;AAC1C,CAAC,CACF;KACA,OAAO,CACN,6BAA6B,EAC7B,4BAA4B,EAC5B,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,yBAAyB,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;AAC7D,CAAC,CACF;KAEA,KAAK,EAAE,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,WAAW,MAAM,yBAAyB,CAAC;AAClD,OAAO,oBAAoB,MAAM,mBAAmB,CAAC;AACrD,OAAO,EACL,uBAAuB,EACvB,iBAAiB,GAClB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAClF,OAAO,EAAE,gBAAgB,EAAE,MAAM,8CAA8C,CAAC;AAChF,OAAO,EACL,0BAA0B,EAC1B,yBAAyB,EACzB,2BAA2B,GAC5B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,iDAAiD,CAAC;AACtF,OAAO,GAAG,MAAM,0BAA0B,CAAC;AAC3C,OAAO,kBAAkB,MAAM,uDAAuD,CAAC;AAEvF,oHAAoH;AACpH,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;KACzB,OAAO,CACN,KAAK,EACL,8DAA8D,EAC9D,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,IAAI,EAAE;IACT,MAAM,GAAG,EAAE,CAAC;AACd,CAAC,CACF;KACA,OAAO,CACN,SAAS,EACT,yCAAyC,EACzC,GAAG,EAAE,GAAE,CAAC,EACR,kBAAkB,CACnB;KACA,OAAO,CAAC,MAAM,EAAE,8BAA8B,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,WAAW,CAAC;KACtE,OAAO,CAAC,MAAM,EAAE,qBAAqB,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,oBAAoB,CAAC;KACtE,OAAO,CACN,mBAAmB,EACnB,gBAAgB,EAChB,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,uBAAuB,CAAC,IAAI,CAAC,CAAC;AACtC,CAAC,CACF;KACA,OAAO,CACN,2BAA2B,EAC3B,wBAAwB,EACxB,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,iBAAiB,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;AACnD,CAAC,CACF;KACA,OAAO,CACN,0BAA0B,EAC1B,uBAAuB,EACvB,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,iBAAiB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;AAClD,CAAC,CACF;KACA,OAAO,CACN,sBAAsB,EACtB,iCAAiC,EACjC,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,0BAA0B,CAAC,IAAI,CAAC,CAAC;AACzC,CAAC,CACF;KACA,OAAO,CACN,8BAA8B,EAC9B,6BAA6B,EAC7B,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,2BAA2B,CAAC,IAAI,CAAC,CAAC;AAC1C,CAAC,CACF;KACA,OAAO,CACN,6BAA6B,EAC7B,4BAA4B,EAC5B,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,yBAAyB,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;AAC7D,CAAC,CACF;KAEA,KAAK,EAAE,CAAC"}
@@ -0,0 +1,8 @@
1
+ import shell from "shelljs";
2
+ import { CLIENT_PATH } from "../../constants.js";
3
+ const cleanCommand = () => {
4
+ shell.cd(CLIENT_PATH);
5
+ shell.exec("git clean -d -x -e node_modules -n");
6
+ };
7
+ export default cleanCommand;
8
+ //# sourceMappingURL=cleanCommand.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cleanCommand.js","sourceRoot":"","sources":["../../../src/local-preview/helper-commands/cleanCommand.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,MAAM,YAAY,GAAG,GAAG,EAAE;IACxB,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IACtB,KAAK,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;AACnD,CAAC,CAAC;AAEF,eAAe,YAAY,CAAC"}
@@ -7,26 +7,12 @@ import { isInternetAvailable } from "is-internet-available";
7
7
  import path from "path";
8
8
  import shell from "shelljs";
9
9
  import categorizeFiles from "./utils/categorizeFiles.js";
10
- import { CMD_EXEC_PATH, CLIENT_PATH, HOME_DIR, DOT_MINTLIFY, LAST_INVOCATION_PATH_FILE_LOCATION, } from "../constants.js";
10
+ import { CMD_EXEC_PATH, CLIENT_PATH, HOME_DIR, DOT_MINTLIFY, } from "../constants.js";
11
11
  import { injectFavicons } from "./utils/injectFavicons.js";
12
12
  import listener from "./utils/listener.js";
13
13
  import { createPage, createMetadataFileFromPages } from "./utils/metadata.js";
14
14
  import { updateConfigFile } from "./utils/mintConfigFile.js";
15
15
  import { buildLogger, ensureYarn } from "../util.js";
16
- import clearCommand from "./helper-commands/clearCommand.js";
17
- const saveInvocationPath = async () => {
18
- await fse.outputFile(LAST_INVOCATION_PATH_FILE_LOCATION, CMD_EXEC_PATH);
19
- };
20
- const cleanOldFiles = async () => {
21
- const lastInvocationPathExists = await pathExists(LAST_INVOCATION_PATH_FILE_LOCATION);
22
- if (!lastInvocationPathExists)
23
- return;
24
- const lastInvocationPath = (await readFile(LAST_INVOCATION_PATH_FILE_LOCATION)).toString();
25
- if (lastInvocationPath !== CMD_EXEC_PATH) {
26
- // clean if invoked in new location
27
- await clearCommand({});
28
- }
29
- };
30
16
  const { readFile } = _promises;
31
17
  const copyFiles = async (logger) => {
32
18
  logger.start("Syncing doc files...");
@@ -106,7 +92,6 @@ const promptForYarn = async () => {
106
92
  };
107
93
  const dev = async () => {
108
94
  shell.cd(HOME_DIR);
109
- await cleanOldFiles();
110
95
  await promptForYarn();
111
96
  const logger = buildLogger("Starting a local Mintlify instance...");
112
97
  await fse.ensureDir(path.join(DOT_MINTLIFY, "mint"));
@@ -162,7 +147,6 @@ const dev = async () => {
162
147
  `);
163
148
  process.exit(1);
164
149
  }
165
- await saveInvocationPath();
166
150
  await copyFiles(logger);
167
151
  run();
168
152
  };
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/local-preview/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,QAAQ,IAAI,SAAS,EAAE,MAAM,IAAI,CAAC;AAC3C,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,MAAM,4BAA4B,CAAC;AACzD,OAAO,EACL,aAAa,EACb,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,kCAAkC,GACnC,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,QAAQ,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,2BAA2B,EAAE,MAAM,qBAAqB,CAAC;AAC9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,YAAY,MAAM,mCAAmC,CAAC;AAE7D,MAAM,kBAAkB,GAAG,KAAK,IAAI,EAAE;IACpC,MAAM,GAAG,CAAC,UAAU,CAAC,kCAAkC,EAAE,aAAa,CAAC,CAAC;AAC1E,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,KAAK,IAAI,EAAE;IAC/B,MAAM,wBAAwB,GAAG,MAAM,UAAU,CAC/C,kCAAkC,CACnC,CAAC;IACF,IAAI,CAAC,wBAAwB;QAAE,OAAO;IACtC,MAAM,kBAAkB,GAAG,CACzB,MAAM,QAAQ,CAAC,kCAAkC,CAAC,CACnD,CAAC,QAAQ,EAAE,CAAC;IACb,IAAI,kBAAkB,KAAK,aAAa,EAAE;QACxC,mCAAmC;QACnC,MAAM,YAAY,CAAC,EAAE,CAAC,CAAC;KACxB;AACH,CAAC,CAAC;AAEF,MAAM,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC;AAE/B,MAAM,SAAS,GAAG,KAAK,EAAE,MAAW,EAAE,EAAE;IACtC,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;IACrC,KAAK,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC;IACxB,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,MAAM,eAAe,EAAE,CAAC;IAExE,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAEjD,MAAM,iBAAiB,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;IACxE,IAAI,OAAO,EAAE;QACX,MAAM,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;QACtC,MAAM,GAAG,CAAC,UAAU,CAAC,iBAAiB,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;YAC/D,IAAI,EAAE,GAAG;SACV,CAAC,CAAC;KACJ;SAAM;QACL,MAAM,GAAG,CAAC,UAAU,CAAC,iBAAiB,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;KAC9D;IACD,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,MAAM,UAAU,GAAG,EAAE,CAAC;IACtB,aAAa,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QACjC,UAAU,CAAC,IAAI,CACb,CAAC,KAAK,IAAI,EAAE;YACV,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;YACtD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;YACxD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAEjD,MAAM,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC7B,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YAEvC,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,UAAU,CAAC,CAAC;YAC/C,MAAM,UAAU,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAC;YAC1C,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;YACvD,KAAK,mCACA,KAAK,GACL,IAAI,CACR,CAAC;QACJ,CAAC,CAAC,EAAE,CACL,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,MAAM,kBAAkB,GAAG,EAAE,CAAC;IAC9B,WAAW,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC/B,kBAAkB,CAAC,IAAI,CACrB,CAAC,KAAK,IAAI,EAAE;YACV,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;YACtD,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;YACnD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YAElD,MAAM,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC7B,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QACzC,CAAC,CAAC,EAAE,CACL,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,MAAM,OAAO,CAAC,GAAG,CAAC;QAChB,GAAG,UAAU;QACb,GAAG,kBAAkB;QACrB,MAAM,cAAc,CAAC,SAAS,EAAE,MAAM,CAAC;KACxC,CAAC,CAAC;IACH,2BAA2B,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAC9C,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;AACrC,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,EAAE;IAChC,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEF,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,GAAG,GAAG,KAAK,IAAI,EAAE;IACrB,KAAK,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;IACnB,MAAM,aAAa,EAAE,CAAC;IACtB,MAAM,aAAa,EAAE,CAAC;IACtB,MAAM,MAAM,GAAG,WAAW,CAAC,uCAAuC,CAAC,CAAC;IACpE,MAAM,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC;IACrD,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC;IACnD,IAAI,OAAO,GAAG,IAAI,CAAC;IACnB,MAAM,YAAY,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACxC,IAAI,iBAAiB,GAAG,KAAK,CAAC;IAC9B,MAAM,kBAAkB,GAAG,MAAM,UAAU,CACzC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,CACxC,CAAC;IACF,IAAI,CAAC,kBAAkB,EAAE;QACvB,iBAAiB,GAAG,IAAI,CAAC;QACzB,IAAI,YAAY,EAAE;YAChB,MAAM,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC;YACxD,SAAS,CAAC,UAAU,CAAC,CAAC;YACtB,SAAS,CACP,oEAAoE,CACrE,CAAC;SACH;aAAM;YACL,MAAM,CAAC,IAAI,CACT,mEAAmE,CACpE,CAAC;YACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACjB;KACF;IAED,MAAM,QAAQ,GAAG,MAAM,mBAAmB,EAAE,CAAC;IAC7C,IAAI,UAAU,GAAG,IAAI,CAAC;IACtB,IAAI,QAAQ,IAAI,YAAY,EAAE;QAC5B,SAAS,CAAC,qCAAqC,CAAC,CAAC;QACjD,SAAS,CAAC,6CAA6C,CAAC,CAAC;QACzD,UAAU,GAAG,SAAS,CAAC,2BAA2B,CAAC,CAAC,MAAM,CAAC;QAC3D,SAAS,CAAC,sCAAsC,CAAC,CAAC;QAClD,SAAS,CAAC,8BAA8B,CAAC,CAAC;KAC3C;IACD,IAAI,UAAU,KAAK,uBAAuB,EAAE;QAC1C,OAAO,GAAG,KAAK,CAAC;KACjB;IACD,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IACtB,IAAI,QAAQ,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,MAAM,iBAAiB,EAAE,CAAC,CAAC,EAAE;QACzD,IAAI,iBAAiB,EAAE;YACrB,MAAM,CAAC,OAAO,CAAC,qCAAqC,CAAC,CAAC;SACvD;QACD,MAAM,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;QACzC,UAAU,CAAC,MAAM,CAAC,CAAC;QACnB,SAAS,CAAC,MAAM,CAAC,CAAC;QAClB,IAAI,iBAAiB,EAAE;YACrB,MAAM,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;SACzC;aAAM;YACL,MAAM,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;SACxC;KACF;IAED,IAAI,CAAC,CAAC,MAAM,iBAAiB,EAAE,CAAC,EAAE;QAChC,MAAM,CAAC,IAAI,CAAC;;;;KAIX,CAAC,CAAC;QACH,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IACD,MAAM,kBAAkB,EAAE,CAAC;IAC3B,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC;IACxB,GAAG,EAAE,CAAC;AACR,CAAC,CAAC;AAEF,MAAM,GAAG,GAAG,GAAG,EAAE;IACf,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IACtB,OAAO,CAAC,GAAG,CACT,MAAM,KAAK,CAAC,KAAK,CACf,yDAAyD,CAC1D,EAAE,CACJ,CAAC;IACF,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3C,IAAI,CAAC,uBAAuB,CAAC,CAAC;IAC9B,QAAQ,EAAE,CAAC;AACb,CAAC,CAAC;AAEF,eAAe,GAAG,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/local-preview/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,QAAQ,IAAI,SAAS,EAAE,MAAM,IAAI,CAAC;AAC3C,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,MAAM,4BAA4B,CAAC;AACzD,OAAO,EACL,aAAa,EACb,WAAW,EACX,QAAQ,EACR,YAAY,GACb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,QAAQ,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,2BAA2B,EAAE,MAAM,qBAAqB,CAAC;AAC9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAErD,MAAM,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC;AAE/B,MAAM,SAAS,GAAG,KAAK,EAAE,MAAW,EAAE,EAAE;IACtC,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;IACrC,KAAK,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC;IACxB,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,MAAM,eAAe,EAAE,CAAC;IAExE,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAEjD,MAAM,iBAAiB,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;IACxE,IAAI,OAAO,EAAE;QACX,MAAM,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;QACtC,MAAM,GAAG,CAAC,UAAU,CAAC,iBAAiB,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;YAC/D,IAAI,EAAE,GAAG;SACV,CAAC,CAAC;KACJ;SAAM;QACL,MAAM,GAAG,CAAC,UAAU,CAAC,iBAAiB,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;KAC9D;IACD,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,MAAM,UAAU,GAAG,EAAE,CAAC;IACtB,aAAa,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QACjC,UAAU,CAAC,IAAI,CACb,CAAC,KAAK,IAAI,EAAE;YACV,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;YACtD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;YACxD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAEjD,MAAM,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC7B,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YAEvC,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,UAAU,CAAC,CAAC;YAC/C,MAAM,UAAU,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAC;YAC1C,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;YACvD,KAAK,mCACA,KAAK,GACL,IAAI,CACR,CAAC;QACJ,CAAC,CAAC,EAAE,CACL,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,MAAM,kBAAkB,GAAG,EAAE,CAAC;IAC9B,WAAW,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC/B,kBAAkB,CAAC,IAAI,CACrB,CAAC,KAAK,IAAI,EAAE;YACV,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;YACtD,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;YACnD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YAElD,MAAM,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC7B,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QACzC,CAAC,CAAC,EAAE,CACL,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,MAAM,OAAO,CAAC,GAAG,CAAC;QAChB,GAAG,UAAU;QACb,GAAG,kBAAkB;QACrB,MAAM,cAAc,CAAC,SAAS,EAAE,MAAM,CAAC;KACxC,CAAC,CAAC;IACH,2BAA2B,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAC9C,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;AACrC,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,EAAE;IAChC,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEF,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,GAAG,GAAG,KAAK,IAAI,EAAE;IACrB,KAAK,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;IACnB,MAAM,aAAa,EAAE,CAAC;IACtB,MAAM,MAAM,GAAG,WAAW,CAAC,uCAAuC,CAAC,CAAC;IACpE,MAAM,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC;IACrD,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC;IACnD,IAAI,OAAO,GAAG,IAAI,CAAC;IACnB,MAAM,YAAY,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACxC,IAAI,iBAAiB,GAAG,KAAK,CAAC;IAC9B,MAAM,kBAAkB,GAAG,MAAM,UAAU,CACzC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,CACxC,CAAC;IACF,IAAI,CAAC,kBAAkB,EAAE;QACvB,iBAAiB,GAAG,IAAI,CAAC;QACzB,IAAI,YAAY,EAAE;YAChB,MAAM,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC;YACxD,SAAS,CAAC,UAAU,CAAC,CAAC;YACtB,SAAS,CACP,oEAAoE,CACrE,CAAC;SACH;aAAM;YACL,MAAM,CAAC,IAAI,CACT,mEAAmE,CACpE,CAAC;YACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACjB;KACF;IAED,MAAM,QAAQ,GAAG,MAAM,mBAAmB,EAAE,CAAC;IAC7C,IAAI,UAAU,GAAG,IAAI,CAAC;IACtB,IAAI,QAAQ,IAAI,YAAY,EAAE;QAC5B,SAAS,CAAC,qCAAqC,CAAC,CAAC;QACjD,SAAS,CAAC,6CAA6C,CAAC,CAAC;QACzD,UAAU,GAAG,SAAS,CAAC,2BAA2B,CAAC,CAAC,MAAM,CAAC;QAC3D,SAAS,CAAC,sCAAsC,CAAC,CAAC;QAClD,SAAS,CAAC,8BAA8B,CAAC,CAAC;KAC3C;IACD,IAAI,UAAU,KAAK,uBAAuB,EAAE;QAC1C,OAAO,GAAG,KAAK,CAAC;KACjB;IACD,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IACtB,IAAI,QAAQ,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,MAAM,iBAAiB,EAAE,CAAC,CAAC,EAAE;QACzD,IAAI,iBAAiB,EAAE;YACrB,MAAM,CAAC,OAAO,CAAC,qCAAqC,CAAC,CAAC;SACvD;QACD,MAAM,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;QACzC,UAAU,CAAC,MAAM,CAAC,CAAC;QACnB,SAAS,CAAC,MAAM,CAAC,CAAC;QAClB,IAAI,iBAAiB,EAAE;YACrB,MAAM,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;SACzC;aAAM;YACL,MAAM,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;SACxC;KACF;IAED,IAAI,CAAC,CAAC,MAAM,iBAAiB,EAAE,CAAC,EAAE;QAChC,MAAM,CAAC,IAAI,CAAC;;;;KAIX,CAAC,CAAC;QACH,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IACD,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC;IACxB,GAAG,EAAE,CAAC;AACR,CAAC,CAAC;AAEF,MAAM,GAAG,GAAG,GAAG,EAAE;IACf,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IACtB,OAAO,CAAC,GAAG,CACT,MAAM,KAAK,CAAC,KAAK,CACf,yDAAyD,CAC1D,EAAE,CACJ,CAAC;IACF,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3C,IAAI,CAAC,uBAAuB,CAAC,CAAC;IAC9B,QAAQ,EAAE,CAAC;AACb,CAAC,CAAC;AAEF,eAAe,GAAG,CAAC"}
@@ -53,11 +53,8 @@ export async function scrapeSectionAutomatically(argv) {
53
53
  }
54
54
  function validateFramework(framework) {
55
55
  if (!framework) {
56
- console.log("Could not detect the framework automatically. Please use one of:");
57
- console.log("scrape-page-docusaurus");
58
- console.log("scrape-page-gitbook");
59
- console.log("scrape-page-readme");
60
- return process.exit(1);
56
+ console.log("Could not detect the framework automatically. We only support Docusaurus (V2 and V3), GitBook, and ReadMe.");
57
+ process.exit();
61
58
  }
62
59
  }
63
60
  //# sourceMappingURL=scrapeSectionCommands.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"scrapeSectionCommands.js","sourceRoot":"","sources":["../../src/scraping/scrapeSectionCommands.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,uBAAuB,EAAE,MAAM,4CAA4C,CAAC;AACrF,OAAO,yBAAyB,MAAM,8CAA8C,CAAC;AACrF,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAC;AAC/E,OAAO,sBAAsB,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC;AAC7E,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAAC,IAAS,EAAE,UAAe;IACxE,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IACtB,MAAM,aAAa,CACjB,UAAU,EACV,IAAI,EACJ,SAAS,CAAC,IAAI,CAAC,EACf,IAAI,CAAC,SAAS,EACd,SAAS,CACV,CAAC;IACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,8BAA8B,CAClD,IAAS,EACT,OAAe,CAAC,kBAAkB;;IAElC,MAAM,6BAA6B,CACjC,IAAI,EACJ,yBAAyB,EACzB,uBAAuB,EACvB,OAAO,CACR,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAAC,IAAS;IACzD,MAAM,6BAA6B,CACjC,IAAI,EACJ,sBAAsB,EACtB,oBAAoB,CACrB,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,6BAA6B,CAC1C,IAAS,EACT,SAAc,EACd,UAAe,EACf,OAAgB;IAEhB,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IAEnC,MAAM,OAAO,GAAG,MAAM,YAAY,EAAE,CAAC;IACrC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;IACrC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;QACpB,SAAS,EAAE,cAAc;KAC1B,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,CAAC;IACnC,OAAO,CAAC,KAAK,EAAE,CAAC;IAChB,MAAM,aAAa,CACjB,UAAU,EACV,IAAI,EACJ,SAAS,CAAC,IAAI,CAAC,EACf,IAAI,CAAC,SAAS,EACd,OAAO,CACR,CAAC;IACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAAC,IAAS;IACxD,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IACtB,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IAErD,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAE7B,OAAO,CAAC,GAAG,CAAC,sBAAsB,GAAG,SAAS,CAAC,CAAC;IAEhD,IAAI,SAAS,KAAK,UAAU,CAAC,UAAU,EAAE;QACvC,MAAM,8BAA8B,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;KACrD;SAAM,IAAI,SAAS,KAAK,UAAU,CAAC,OAAO,EAAE;QAC3C,MAAM,2BAA2B,CAAC,IAAI,CAAC,CAAC;KACzC;SAAM,IAAI,SAAS,KAAK,UAAU,CAAC,MAAM,EAAE;QAC1C,MAAM,yBAAyB,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;KAC5D;AACH,CAAC;AAED,SAAS,iBAAiB,CAAC,SAAiC;IAC1D,IAAI,CAAC,SAAS,EAAE;QACd,OAAO,CAAC,GAAG,CACT,kEAAkE,CACnE,CAAC;QACF,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;QACtC,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;QACnC,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;QAClC,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACxB;AACH,CAAC"}
1
+ {"version":3,"file":"scrapeSectionCommands.js","sourceRoot":"","sources":["../../src/scraping/scrapeSectionCommands.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,uBAAuB,EAAE,MAAM,4CAA4C,CAAC;AACrF,OAAO,yBAAyB,MAAM,8CAA8C,CAAC;AACrF,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAC;AAC/E,OAAO,sBAAsB,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC;AAC7E,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAAC,IAAS,EAAE,UAAe;IACxE,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IACtB,MAAM,aAAa,CACjB,UAAU,EACV,IAAI,EACJ,SAAS,CAAC,IAAI,CAAC,EACf,IAAI,CAAC,SAAS,EACd,SAAS,CACV,CAAC;IACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,8BAA8B,CAClD,IAAS,EACT,OAAe,CAAC,kBAAkB;;IAElC,MAAM,6BAA6B,CACjC,IAAI,EACJ,yBAAyB,EACzB,uBAAuB,EACvB,OAAO,CACR,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAAC,IAAS;IACzD,MAAM,6BAA6B,CACjC,IAAI,EACJ,sBAAsB,EACtB,oBAAoB,CACrB,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,6BAA6B,CAC1C,IAAS,EACT,SAAc,EACd,UAAe,EACf,OAAgB;IAEhB,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IAEnC,MAAM,OAAO,GAAG,MAAM,YAAY,EAAE,CAAC;IACrC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;IACrC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;QACpB,SAAS,EAAE,cAAc;KAC1B,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,CAAC;IACnC,OAAO,CAAC,KAAK,EAAE,CAAC;IAChB,MAAM,aAAa,CACjB,UAAU,EACV,IAAI,EACJ,SAAS,CAAC,IAAI,CAAC,EACf,IAAI,CAAC,SAAS,EACd,OAAO,CACR,CAAC;IACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAAC,IAAS;IACxD,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IACtB,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IAErD,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAE7B,OAAO,CAAC,GAAG,CAAC,sBAAsB,GAAG,SAAS,CAAC,CAAC;IAEhD,IAAI,SAAS,KAAK,UAAU,CAAC,UAAU,EAAE;QACvC,MAAM,8BAA8B,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;KACrD;SAAM,IAAI,SAAS,KAAK,UAAU,CAAC,OAAO,EAAE;QAC3C,MAAM,2BAA2B,CAAC,IAAI,CAAC,CAAC;KACzC;SAAM,IAAI,SAAS,KAAK,UAAU,CAAC,MAAM,EAAE;QAC1C,MAAM,yBAAyB,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;KAC5D;AACH,CAAC;AAED,SAAS,iBAAiB,CAAC,SAAiC;IAC1D,IAAI,CAAC,SAAS,EAAE;QACd,OAAO,CAAC,GAAG,CACT,4GAA4G,CAC7G,CAAC;QACF,OAAO,CAAC,IAAI,EAAE,CAAC;KAChB;AACH,CAAC"}
@@ -7,9 +7,11 @@ import alternateGroupTitle from "./alternateGroupTitle.js";
7
7
  export async function scrapeGitBookSection(html, origin, cliDir, overwrite, version) {
8
8
  const $ = cheerio.load(html);
9
9
  // Get all the navigation sections
10
- const navigationSections = $('div[data-testid="page.desktopTableOfContents"] > div > div:first-child')
10
+ // Some variants of the GitBook UI show the logo and search base in the side navigation bar,
11
+ // but the navigation sections are always the last value.
12
+ const navigationSections = $('div[data-testid="page.desktopTableOfContents"] > nav > div:first-child')
11
13
  .children()
12
- .first()
14
+ .eq(-1)
13
15
  .children()
14
16
  .first()
15
17
  .children();
@@ -1 +1 @@
1
- {"version":3,"file":"scrapeGitBookSection.js","sourceRoot":"","sources":["../../../src/scraping/site-scrapers/scrapeGitBookSection.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B,OAAO,EAAE,4BAA4B,EAAE,MAAM,oCAAoC,CAAC;AAClF,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,8BAA8B,MAAM,sCAAsC,CAAC;AAClF,OAAO,mBAAmB,MAAM,0CAA0C,CAAC;AAC3E,OAAO,mBAAmB,MAAM,0BAA0B,CAAC;AAE3D,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,IAAY,EACZ,MAAc,EACd,MAAc,EACd,SAAkB,EAClB,OAA2B;IAE3B,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAE7B,kCAAkC;IAClC,MAAM,kBAAkB,GAAG,CAAC,CAC1B,wEAAwE,CACzE;SACE,QAAQ,EAAE;SACV,KAAK,EAAE;SACP,QAAQ,EAAE;SACV,KAAK,EAAE;SACP,QAAQ,EAAE,CAAC;IAEd,0BAA0B;IAC1B,MAAM,YAAY,GAAG,kBAAkB;SACpC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACZ,MAAM,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACrB,MAAM,YAAY,GAAG,CAAC,CAAC,OAAO,CAAC;aAC5B,IAAI,CAAC,uBAAuB,CAAC;aAC7B,KAAK,EAAE;aACP,IAAI,EAAE,CAAC;QAEV,0DAA0D;QAC1D,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC3C,MAAM,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEzC,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QACzD,MAAM,KAAK,GAAG,mBAAmB,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;QAEnD,OAAO;YACL,KAAK,EAAE,YAAY,IAAI,mBAAmB,CAAC,SAAS,EAAE,KAAK,CAAC;YAC5D,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK;SACjD,CAAC;IACJ,CAAC,CAAC;SACD,OAAO,EAAE;SACT,MAAM,CAAC,OAAO,CAAC,CAAC;IAEnB,0CAA0C;IAC1C,MAAM,mBAAmB,GAAG,8BAA8B,CAAC,YAAY,CAAC,CAAC;IAEzE,sCAAsC;IACtC,MAAM,sBAAsB,GAAG,MAAM,OAAO,CAAC,GAAG,CAC9C,mBAAmB,CAAC,GAAG,CAAC,KAAK,EAAE,QAAyB,EAAE,EAAE;QAC1D,OAAO,MAAM,4BAA4B,CACvC,QAAQ,EACR,MAAM,EACN,MAAM,EACN,SAAS,EACT,iBAAiB,EACjB,IAAI,EACJ,OAAO,CACR,CAAC;IACJ,CAAC,CAAC,CACH,CAAC;IAEF,OAAO,sBAAsB,CAAC;AAChC,CAAC"}
1
+ {"version":3,"file":"scrapeGitBookSection.js","sourceRoot":"","sources":["../../../src/scraping/site-scrapers/scrapeGitBookSection.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B,OAAO,EAAE,4BAA4B,EAAE,MAAM,oCAAoC,CAAC;AAClF,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,8BAA8B,MAAM,sCAAsC,CAAC;AAClF,OAAO,mBAAmB,MAAM,0CAA0C,CAAC;AAC3E,OAAO,mBAAmB,MAAM,0BAA0B,CAAC;AAE3D,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,IAAY,EACZ,MAAc,EACd,MAAc,EACd,SAAkB,EAClB,OAA2B;IAE3B,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAE7B,kCAAkC;IAClC,4FAA4F;IAC5F,yDAAyD;IACzD,MAAM,kBAAkB,GAAG,CAAC,CAC1B,wEAAwE,CACzE;SACE,QAAQ,EAAE;SACV,EAAE,CAAC,CAAC,CAAC,CAAC;SACN,QAAQ,EAAE;SACV,KAAK,EAAE;SACP,QAAQ,EAAE,CAAC;IAEd,0BAA0B;IAC1B,MAAM,YAAY,GAAG,kBAAkB;SACpC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACZ,MAAM,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACrB,MAAM,YAAY,GAAG,CAAC,CAAC,OAAO,CAAC;aAC5B,IAAI,CAAC,uBAAuB,CAAC;aAC7B,KAAK,EAAE;aACP,IAAI,EAAE,CAAC;QAEV,0DAA0D;QAC1D,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC3C,MAAM,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEzC,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QACzD,MAAM,KAAK,GAAG,mBAAmB,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;QAEnD,OAAO;YACL,KAAK,EAAE,YAAY,IAAI,mBAAmB,CAAC,SAAS,EAAE,KAAK,CAAC;YAC5D,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK;SACjD,CAAC;IACJ,CAAC,CAAC;SACD,OAAO,EAAE;SACT,MAAM,CAAC,OAAO,CAAC,CAAC;IAEnB,0CAA0C;IAC1C,MAAM,mBAAmB,GAAG,8BAA8B,CAAC,YAAY,CAAC,CAAC;IAEzE,sCAAsC;IACtC,MAAM,sBAAsB,GAAG,MAAM,OAAO,CAAC,GAAG,CAC9C,mBAAmB,CAAC,GAAG,CAAC,KAAK,EAAE,QAAyB,EAAE,EAAE;QAC1D,OAAO,MAAM,4BAA4B,CACvC,QAAQ,EACR,MAAM,EACN,MAAM,EACN,SAAS,EACT,iBAAiB,EACjB,IAAI,EACJ,OAAO,CACR,CAAC;IACJ,CAAC,CAAC,CACH,CAAC;IAEF,OAAO,sBAAsB,CAAC;AAChC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mintlify",
3
- "version": "1.1.7",
3
+ "version": "1.1.9",
4
4
  "description": "The Mintlify CLI",
5
5
  "engines": {
6
6
  "node": ">=14.16"
package/src/constants.ts CHANGED
@@ -13,8 +13,3 @@ export const CLIENT_PATH = path.join(DOT_MINTLIFY, "mint", "client");
13
13
 
14
14
  // command execution location
15
15
  export const CMD_EXEC_PATH = process.cwd();
16
-
17
- export const LAST_INVOCATION_PATH_FILE_LOCATION = path.join(
18
- CLIENT_PATH,
19
- "last-invocation-path"
20
- );
package/src/index.ts CHANGED
@@ -8,19 +8,16 @@ import {
8
8
  scrapePageAutomatically,
9
9
  scrapePageWrapper,
10
10
  } from "./scraping/scrapePageCommands.js";
11
- import { scrapeDocusaurusPage } from "./scraping/site-scrapers/scrapeDocusaurusPage.js";
12
11
  import { scrapeGitBookPage } from "./scraping/site-scrapers/scrapeGitBookPage.js";
13
12
  import { scrapeReadMePage } from "./scraping/site-scrapers/scrapeReadMePage.js";
14
13
  import {
15
14
  scrapeSectionAutomatically,
16
15
  scrapeSectionAxiosWrapper,
17
16
  scrapeGitbookSectionCommand,
18
- scrapeDocusaurusSectionCommand,
19
17
  } from "./scraping/scrapeSectionCommands.js";
20
18
  import { scrapeReadMeSection } from "./scraping/site-scrapers/scrapeReadMeSection.js";
21
19
  import dev from "./local-preview/index.js";
22
20
  import installDepsCommand from "./local-preview/helper-commands/installDepsCommand.js";
23
- import clearCommand from "./local-preview/helper-commands/clearCommand.js";
24
21
 
25
22
  // TODO - add descriptions to the command options https://github.com/yargs/yargs/blob/HEAD/docs/api.md#commandmodule
26
23
  yargs(hideBin(process.argv))
@@ -38,12 +35,6 @@ yargs(hideBin(process.argv))
38
35
  () => {},
39
36
  installDepsCommand
40
37
  )
41
- .command(
42
- "clear",
43
- "Clear cache",
44
- () => {},
45
- (args) => clearCommand(args)
46
- )
47
38
  .command("init", "Generate a mintlify template", () => {}, initCommand)
48
39
  .command("page", "Generate a new page", () => {}, generatePageTemplate)
49
40
  .command(
@@ -12,32 +12,12 @@ import {
12
12
  CLIENT_PATH,
13
13
  HOME_DIR,
14
14
  DOT_MINTLIFY,
15
- LAST_INVOCATION_PATH_FILE_LOCATION,
16
15
  } from "../constants.js";
17
16
  import { injectFavicons } from "./utils/injectFavicons.js";
18
17
  import listener from "./utils/listener.js";
19
18
  import { createPage, createMetadataFileFromPages } from "./utils/metadata.js";
20
19
  import { updateConfigFile } from "./utils/mintConfigFile.js";
21
20
  import { buildLogger, ensureYarn } from "../util.js";
22
- import clearCommand from "./helper-commands/clearCommand.js";
23
-
24
- const saveInvocationPath = async () => {
25
- await fse.outputFile(LAST_INVOCATION_PATH_FILE_LOCATION, CMD_EXEC_PATH);
26
- };
27
-
28
- const cleanOldFiles = async () => {
29
- const lastInvocationPathExists = await pathExists(
30
- LAST_INVOCATION_PATH_FILE_LOCATION
31
- );
32
- if (!lastInvocationPathExists) return;
33
- const lastInvocationPath = (
34
- await readFile(LAST_INVOCATION_PATH_FILE_LOCATION)
35
- ).toString();
36
- if (lastInvocationPath !== CMD_EXEC_PATH) {
37
- // clean if invoked in new location
38
- await clearCommand({});
39
- }
40
- };
41
21
 
42
22
  const { readFile } = _promises;
43
23
 
@@ -133,7 +113,6 @@ const promptForYarn = async () => {
133
113
 
134
114
  const dev = async () => {
135
115
  shell.cd(HOME_DIR);
136
- await cleanOldFiles();
137
116
  await promptForYarn();
138
117
  const logger = buildLogger("Starting a local Mintlify instance...");
139
118
  await fse.ensureDir(path.join(DOT_MINTLIFY, "mint"));
@@ -195,7 +174,6 @@ const dev = async () => {
195
174
  `);
196
175
  process.exit(1);
197
176
  }
198
- await saveInvocationPath();
199
177
  await copyFiles(logger);
200
178
  run();
201
179
  };
@@ -91,11 +91,8 @@ export async function scrapeSectionAutomatically(argv: any) {
91
91
  function validateFramework(framework: Frameworks | undefined) {
92
92
  if (!framework) {
93
93
  console.log(
94
- "Could not detect the framework automatically. Please use one of:"
94
+ "Could not detect the framework automatically. We only support Docusaurus (V2 and V3), GitBook, and ReadMe."
95
95
  );
96
- console.log("scrape-page-docusaurus");
97
- console.log("scrape-page-gitbook");
98
- console.log("scrape-page-readme");
99
- return process.exit(1);
96
+ process.exit();
100
97
  }
101
98
  }
@@ -16,11 +16,13 @@ export async function scrapeGitBookSection(
16
16
  const $ = cheerio.load(html);
17
17
 
18
18
  // Get all the navigation sections
19
+ // Some variants of the GitBook UI show the logo and search base in the side navigation bar,
20
+ // but the navigation sections are always the last value.
19
21
  const navigationSections = $(
20
- 'div[data-testid="page.desktopTableOfContents"] > div > div:first-child'
22
+ 'div[data-testid="page.desktopTableOfContents"] > nav > div:first-child'
21
23
  )
22
24
  .children()
23
- .first()
25
+ .eq(-1)
24
26
  .children()
25
27
  .first()
26
28
  .children();
@@ -1,94 +0,0 @@
1
- // TODO - add types
2
- import fs from "fs-extra";
3
- import matter from "gray-matter";
4
- import path from "path";
5
- import { getOpenApiTitleAndDescription } from "./getOpenApiContext.js";
6
- import { slugToTitle } from "./slugToTitle.js";
7
- import { CLIENT_PATH } from "../constants.js";
8
- // End matter is front matter, but at the end
9
- const getIndexOfEndMatter = (fileContents) => {
10
- const frontMatters = fileContents.match(/---\n(title:.+\n|description:.+\n|sidebarTitle:.+\n|api:.+\n|openapi:.+\n)+---$/m);
11
- if (frontMatters) {
12
- return fileContents.indexOf(frontMatters[0]);
13
- }
14
- return -1;
15
- };
16
- export const potentiallyRemoveEndMatter = (fileContents) => {
17
- const endMatterIndex = getIndexOfEndMatter(fileContents);
18
- if (endMatterIndex === -1) {
19
- return fileContents;
20
- }
21
- return fileContents.substring(0, endMatterIndex);
22
- };
23
- const getMetadata = (fileContents) => {
24
- const { data } = matter(fileContents);
25
- if (Object.keys(data).length > 0) {
26
- return data;
27
- }
28
- const startIndex = getIndexOfEndMatter(fileContents);
29
- if (startIndex === -1) {
30
- return {};
31
- }
32
- const fileContentFromFrontMatter = fileContents.substring(startIndex);
33
- const { data: nonTopFrontMatter } = matter(fileContentFromFrontMatter);
34
- return nonTopFrontMatter;
35
- };
36
- export const createPage = (path, content, openApiObj) => {
37
- const slug = path.replace(/\.mdx?$/, "").substring(1);
38
- let defaultTitle = slugToTitle(slug);
39
- const metadata = getMetadata(content);
40
- // Append data from OpenAPI if it exists
41
- const { title, description } = getOpenApiTitleAndDescription(openApiObj, metadata === null || metadata === void 0 ? void 0 : metadata.openapi);
42
- if (title) {
43
- defaultTitle = title;
44
- }
45
- return {
46
- [slug]: Object.assign(Object.assign({ title: defaultTitle, description }, metadata), { href: `/${slug}` }),
47
- };
48
- };
49
- export const injectNav = (pages, configObj) => {
50
- const targetPath = path.join(CLIENT_PATH, "src", "nav.json");
51
- const createNav = (nav) => {
52
- return {
53
- group: nav.group,
54
- pages: nav.pages.map((page) => {
55
- if (typeof page === "string") {
56
- return pages[page];
57
- }
58
- return createNav(page);
59
- }),
60
- };
61
- };
62
- if ((configObj === null || configObj === void 0 ? void 0 : configObj.navigation) == null) {
63
- return;
64
- }
65
- let navFile = configObj.navigation.map((nav) => createNav(nav));
66
- const filterOutNullInPages = (pages) => {
67
- const newPages = [];
68
- pages.forEach((page) => {
69
- if (page == null) {
70
- return;
71
- }
72
- if (page === null || page === void 0 ? void 0 : page.pages) {
73
- const newGroup = filterOutNullInGroup(page);
74
- newPages.push(newGroup);
75
- }
76
- else {
77
- newPages.push(page);
78
- }
79
- });
80
- return newPages;
81
- };
82
- const filterOutNullInGroup = (group) => {
83
- const newPages = filterOutNullInPages(group.pages);
84
- const newGroup = Object.assign(Object.assign({}, group), { pages: newPages });
85
- return newGroup;
86
- };
87
- const newNavFile = navFile.map((group) => {
88
- return filterOutNullInGroup(group);
89
- });
90
- fs.outputFileSync(targetPath, JSON.stringify(newNavFile, null, 2), {
91
- flag: "w",
92
- });
93
- };
94
- //# sourceMappingURL=injectNav.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"injectNav.js","sourceRoot":"","sources":["../../src/local-preview/injectNav.ts"],"names":[],"mappings":"AAAA,mBAAmB;AACnB,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,EAAE,6BAA6B,EAAE,MAAM,wBAAwB,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C,6CAA6C;AAC7C,MAAM,mBAAmB,GAAG,CAAC,YAAoB,EAAE,EAAE;IACnD,MAAM,YAAY,GAAG,YAAY,CAAC,KAAK,CACrC,kFAAkF,CACnF,CAAC;IACF,IAAI,YAAY,EAAE;QAChB,OAAO,YAAY,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;KAC9C;IAED,OAAO,CAAC,CAAC,CAAC;AACZ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,YAAoB,EAAE,EAAE;IACjE,MAAM,cAAc,GAAG,mBAAmB,CAAC,YAAY,CAAC,CAAC;IAEzD,IAAI,cAAc,KAAK,CAAC,CAAC,EAAE;QACzB,OAAO,YAAY,CAAC;KACrB;IAED,OAAO,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;AACnD,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,YAAoB,EAAE,EAAE;IAC3C,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;IAEtC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;QAChC,OAAO,IAAI,CAAC;KACb;IAED,MAAM,UAAU,GAAG,mBAAmB,CAAC,YAAY,CAAC,CAAC;IACrD,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE;QACrB,OAAO,EAAE,CAAC;KACX;IAED,MAAM,0BAA0B,GAAG,YAAY,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IACtE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,MAAM,CAAC,0BAA0B,CAAC,CAAC;IACvE,OAAO,iBAAiB,CAAC;AAC3B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,IAAY,EACZ,OAAe,EACf,UAAyB,EACzB,EAAE;IACF,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IACtD,IAAI,YAAY,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IACtC,wCAAwC;IACxC,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,6BAA6B,CAC1D,UAAU,EACV,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,CAClB,CAAC;IACF,IAAI,KAAK,EAAE;QACT,YAAY,GAAG,KAAK,CAAC;KACtB;IACD,OAAO;QACL,CAAC,IAAI,CAAC,gCAAI,KAAK,EAAE,YAAY,EAAE,WAAW,IAAK,QAAQ,KAAE,IAAI,EAAE,IAAI,IAAI,EAAE,GAAE;KAC5E,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,KAAU,EAAE,SAAc,EAAE,EAAE;IACtD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;IAC7D,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,EAAE;QACxB,OAAO;YACL,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC5B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;oBAC5B,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC;iBACpB;gBAED,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC;YACzB,CAAC,CAAC;SACH,CAAC;IACJ,CAAC,CAAC;IAEF,IAAI,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,UAAU,KAAI,IAAI,EAAE;QACjC,OAAO;KACR;IAED,IAAI,OAAO,GAAG,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;IAChE,MAAM,oBAAoB,GAAG,CAAC,KAAK,EAAE,EAAE;QACrC,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrB,IAAI,IAAI,IAAI,IAAI,EAAE;gBAChB,OAAO;aACR;YACD,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,EAAE;gBACf,MAAM,QAAQ,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC;gBAC5C,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;aACzB;iBAAM;gBACL,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aACrB;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;IACF,MAAM,oBAAoB,GAAG,CAAC,KAAK,EAAE,EAAE;QACrC,MAAM,QAAQ,GAAG,oBAAoB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACnD,MAAM,QAAQ,mCACT,KAAK,KACR,KAAK,EAAE,QAAQ,GAChB,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;IACF,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACvC,OAAO,oBAAoB,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE;QACjE,IAAI,EAAE,GAAG;KACV,CAAC,CAAC;AACL,CAAC,CAAC"}
@@ -1,5 +0,0 @@
1
- {
2
- "fontawesome-svg-core": {
3
- "license": "pro"
4
- }
5
- }
@@ -1,4 +0,0 @@
1
- {
2
- "presets": ["next/babel"],
3
- "plugins": ["macros"]
4
- }
@@ -1,12 +0,0 @@
1
- root = true
2
-
3
- [*]
4
- indent_style = space
5
- indent_size = 2
6
- end_of_line = lf
7
- charset = utf-8
8
- trim_trailing_whitespace = true
9
- insert_final_newline = true
10
-
11
- [*.mdx]
12
- trim_trailing_whitespace = false
@@ -1,7 +0,0 @@
1
- {
2
- "extends": "react-app",
3
- "rules": {
4
- "react/react-in-jsx-scope": "off",
5
- "jsx-a11y/anchor-is-valid": "off"
6
- }
7
- }
@@ -1,4 +0,0 @@
1
- **/*.mdx
2
- **/generated/
3
- src/samples/
4
- **/snippet.*
@@ -1,14 +0,0 @@
1
- {
2
- "singleQuote": true,
3
- "printWidth": 100,
4
- "trailingComma": "es5",
5
- "arrowParens": "always",
6
- "tabWidth": 2,
7
- "useTabs": false,
8
- "quoteProps": "as-needed",
9
- "jsxSingleQuote": false,
10
- "bracketSpacing": true,
11
- "bracketSameLine": false,
12
- "importOrder": ["<THIRD_PARTY_MODULES>", "^@/(.*)$", "^[./]"],
13
- "importOrderSeparation": true
14
- }
@@ -1,28 +0,0 @@
1
- {
2
- "version": "0.2.0",
3
- "configurations": [
4
- {
5
- "name": "Next.js: debug server-side",
6
- "type": "node-terminal",
7
- "request": "launch",
8
- "command": "yarn dev"
9
- },
10
- {
11
- "name": "Next.js: debug client-side",
12
- "type": "chrome",
13
- "request": "launch",
14
- "url": "http://localhost:3000"
15
- },
16
- {
17
- "name": "Next.js: debug full stack",
18
- "type": "node-terminal",
19
- "request": "launch",
20
- "command": "yarn dev",
21
- "serverReadyAction": {
22
- "pattern": "started server on .+, url: (https?://.+)",
23
- "uriFormat": "%s",
24
- "action": "debugWithChrome"
25
- }
26
- }
27
- ]
28
- }
@@ -1,44 +0,0 @@
1
- # Mintlify Client
2
-
3
- The client is essentially a frontend template used to host documentation. In production, when `yarn prebuild` is ran it fetches all the relevant assets (the config file, the content (mdx files), and static assets) and plugs them into the appropriate locations before building.
4
-
5
- ## Your First Code Contribution
6
-
7
- ### Prerequisites
8
-
9
- - Node v16.13.2 (npm v8.1.2)
10
- - Yarn
11
-
12
- ### Dependencies
13
-
14
- From a terminal, where you have cloned the repository, execute the following command to install the required dependencies:
15
-
16
- ```
17
- yarn
18
- ```
19
-
20
- ### Build
21
-
22
- - `INTERNAL_SITE_BEARER_TOKEN=example yarn prebuild` - fetches the files for the site associated with that bearer token from GitHub. You need the pre-hashed bearer token for that to work. Mintlify employees can request the token that grants access to a test site. In the future, we will work on a way of generating temporary bearer tokens from an employee login.
23
- - `yarn local` - the local version of `yarn prebuild` (fetches the content from the local `../docs` folder). It can take in a filepath as a parameter for when you want to transfer files to a directory that isn't `../docs`. For example, let's say I'm working on a migration for a client, then I can run `yarn local ../../clients/vital/docs` to get the files from that folder.
24
-
25
- ### Watch
26
-
27
- ```
28
- yarn dev
29
- ```
30
-
31
- ### Formatting
32
-
33
- This project uses [prettier](https://prettier.io/) for code formatting. You can run prettier across the code by calling `yarn run format` from a terminal.
34
-
35
- To format the code as you make changes you can install the [Prettier - Code formatter](https://marketplace.visualstudio.com/items/esbenp.prettier-vscode) extension.
36
-
37
- Add the following to your User Settings to run prettier:
38
-
39
- ```
40
- "editor.formatOnSave": true,
41
- "editor.defaultFormatter": "esbenp.prettier-vscode"
42
- ```
43
-
44
- You can either modify the `settings.json` file or click on Preferences > Settings to use the UI.