mintlify 1.1.9 → 1.1.10

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 (164) hide show
  1. package/README.md +3 -1
  2. package/bin/local-preview/index.js +1 -1
  3. package/bin/local-preview/index.js.map +1 -1
  4. package/bin/local-preview/injectNav.js +94 -0
  5. package/bin/local-preview/injectNav.js.map +1 -0
  6. package/bin/mint/client/.babel-plugin-macrosrc.json +5 -0
  7. package/bin/mint/client/.babelrc +4 -0
  8. package/bin/mint/client/.editorconfig +12 -0
  9. package/bin/mint/client/.eslintrc.json +7 -0
  10. package/bin/mint/client/.prettierignore +4 -0
  11. package/bin/mint/client/.prettierrc +14 -0
  12. package/bin/mint/client/.vscode/launch.json +28 -0
  13. package/bin/mint/client/README.md +44 -0
  14. package/bin/mint/client/jest.config.ts +195 -0
  15. package/bin/mint/client/next-env.d.ts +4 -0
  16. package/bin/mint/client/next.config.js +152 -0
  17. package/bin/mint/client/package.json +139 -0
  18. package/bin/mint/client/postcss.config.cjs +9 -0
  19. package/bin/mint/client/prebuild/faviconConfig.js +35 -0
  20. package/bin/mint/client/prebuild/getOpenApiContext.js +53 -0
  21. package/bin/mint/client/prebuild/index.js +117 -0
  22. package/bin/mint/client/prebuild/injectNav.js +115 -0
  23. package/bin/mint/client/prebuild/slugToTitle.js +7 -0
  24. package/bin/mint/client/rehype/withApiComponents.js +60 -0
  25. package/bin/mint/client/rehype/withCodeBlocks.js +54 -0
  26. package/bin/mint/client/rehype/withLayouts.js +113 -0
  27. package/bin/mint/client/rehype/withLinkRoles.js +13 -0
  28. package/bin/mint/client/rehype/withRawComponents.js +13 -0
  29. package/bin/mint/client/rehype/withStaticProps.js +25 -0
  30. package/bin/mint/client/rehype/withSyntaxHighlighting.js +60 -0
  31. package/bin/mint/client/remark/utils.js +369 -0
  32. package/bin/mint/client/remark/withFrames.js +55 -0
  33. package/bin/mint/client/remark/withImportsInjected.js +36 -0
  34. package/bin/mint/client/remark/withNextLinks.js +37 -0
  35. package/bin/mint/client/remark/withTableOfContents.js +71 -0
  36. package/bin/mint/client/scripts/local.js +177 -0
  37. package/bin/mint/client/sentry.client.config.js +15 -0
  38. package/bin/mint/client/sentry.properties +4 -0
  39. package/bin/mint/client/sentry.server.config.js +15 -0
  40. package/bin/mint/client/src/analytics/AbstractAnalyticsImplementation.ts +50 -0
  41. package/bin/mint/client/src/analytics/AnalyticsContext.ts +5 -0
  42. package/bin/mint/client/src/analytics/AnalyticsMediator.ts +101 -0
  43. package/bin/mint/client/src/analytics/FakeAnalyticsMediator.ts +9 -0
  44. package/bin/mint/client/src/analytics/GA4Script.tsx +33 -0
  45. package/bin/mint/client/src/analytics/implementations/amplitude.ts +26 -0
  46. package/bin/mint/client/src/analytics/implementations/fathom.ts +38 -0
  47. package/bin/mint/client/src/analytics/implementations/ga4.ts +33 -0
  48. package/bin/mint/client/src/analytics/implementations/hotjar.ts +53 -0
  49. package/bin/mint/client/src/analytics/implementations/mixpanel-browser.d.ts +1 -0
  50. package/bin/mint/client/src/analytics/implementations/mixpanel.ts +52 -0
  51. package/bin/mint/client/src/analytics/implementations/posthog.ts +37 -0
  52. package/bin/mint/client/src/components/Accordion/Accordion.tsx +43 -0
  53. package/bin/mint/client/src/components/Accordion/index.ts +4 -0
  54. package/bin/mint/client/src/components/ApiExample.tsx +9 -0
  55. package/bin/mint/client/src/components/Card.tsx +51 -0
  56. package/bin/mint/client/src/components/CodeGroup.tsx +132 -0
  57. package/bin/mint/client/src/components/Editor.tsx +12 -0
  58. package/bin/mint/client/src/components/Expandable.tsx +40 -0
  59. package/bin/mint/client/src/components/Heading.tsx +84 -0
  60. package/bin/mint/client/src/components/Param.tsx +56 -0
  61. package/bin/mint/client/src/components/Request.tsx +19 -0
  62. package/bin/mint/client/src/components/ResponseField.tsx +33 -0
  63. package/bin/mint/client/src/components/TabBar.tsx +61 -0
  64. package/bin/mint/client/src/config.ts +115 -0
  65. package/bin/mint/client/src/css/bar-of-progress.css +10 -0
  66. package/bin/mint/client/src/css/base.css +29 -0
  67. package/bin/mint/client/src/css/font-awesome.css +7 -0
  68. package/bin/mint/client/src/css/fonts.css +44 -0
  69. package/bin/mint/client/src/css/main.css +11 -0
  70. package/bin/mint/client/src/css/prism.css +270 -0
  71. package/bin/mint/client/src/css/utilities.css +43 -0
  72. package/bin/mint/client/src/enums/components.ts +8 -0
  73. package/bin/mint/client/src/fonts/FiraCode-VF.woff +0 -0
  74. package/bin/mint/client/src/fonts/FiraCode-VF.woff2 +0 -0
  75. package/bin/mint/client/src/fonts/IBMPlexMono-Regular.ttf +0 -0
  76. package/bin/mint/client/src/fonts/IBMPlexMono-SemiBold.ttf +0 -0
  77. package/bin/mint/client/src/fonts/Inter-italic-latin.var.woff2 +0 -0
  78. package/bin/mint/client/src/fonts/Inter-roman-latin.var.woff2 +0 -0
  79. package/bin/mint/client/src/fonts/Pally-Variable.ttf +0 -0
  80. package/bin/mint/client/src/fonts/SourceSansPro-Regular.otf +0 -0
  81. package/bin/mint/client/src/fonts/SourceSerifPro-Regular.ttf +0 -0
  82. package/bin/mint/client/src/fonts/Synonym-Variable.ttf +0 -0
  83. package/bin/mint/client/src/fonts/Ubuntu-Mono-bold.woff2 +0 -0
  84. package/bin/mint/client/src/fonts/generated/IBMPlexMono-Regular-subset.woff2 +0 -0
  85. package/bin/mint/client/src/fonts/generated/IBMPlexMono-Regular-subset.zopfli.woff +0 -0
  86. package/bin/mint/client/src/fonts/generated/IBMPlexMono-Regular.module.css +11 -0
  87. package/bin/mint/client/src/fonts/generated/IBMPlexMono-SemiBold-subset.woff2 +0 -0
  88. package/bin/mint/client/src/fonts/generated/IBMPlexMono-SemiBold-subset.zopfli.woff +0 -0
  89. package/bin/mint/client/src/fonts/generated/IBMPlexMono-SemiBold.module.css +11 -0
  90. package/bin/mint/client/src/fonts/generated/Pally-Variable-subset.woff2 +0 -0
  91. package/bin/mint/client/src/fonts/generated/Pally-Variable-subset.zopfli.woff +0 -0
  92. package/bin/mint/client/src/fonts/generated/Pally-Variable.module.css +11 -0
  93. package/bin/mint/client/src/fonts/generated/SourceSerifPro-Regular-subset.woff2 +0 -0
  94. package/bin/mint/client/src/fonts/generated/SourceSerifPro-Regular-subset.zopfli.woff +0 -0
  95. package/bin/mint/client/src/fonts/generated/SourceSerifPro-Regular.module.css +11 -0
  96. package/bin/mint/client/src/fonts/generated/Synonym-Variable-subset.woff2 +0 -0
  97. package/bin/mint/client/src/fonts/generated/Synonym-Variable-subset.zopfli.woff +0 -0
  98. package/bin/mint/client/src/fonts/generated/Synonym-Variable.module.css +11 -0
  99. package/bin/mint/client/src/fonts/generated/TenorSans-Regular-subset.woff2 +0 -0
  100. package/bin/mint/client/src/fonts/generated/TenorSans-Regular-subset.zopfli.woff +0 -0
  101. package/bin/mint/client/src/fonts/generated/TenorSans-Regular.module.css +11 -0
  102. package/bin/mint/client/src/hooks/useActionKey.ts +20 -0
  103. package/bin/mint/client/src/hooks/useIsomorphicLayoutEffect.ts +3 -0
  104. package/bin/mint/client/src/hooks/useMedia.ts +27 -0
  105. package/bin/mint/client/src/hooks/usePrevNext.ts +34 -0
  106. package/bin/mint/client/src/hooks/useTop.ts +15 -0
  107. package/bin/mint/client/src/icons/CopyToClipboard.tsx +33 -0
  108. package/bin/mint/client/src/index.d.ts +1 -0
  109. package/bin/mint/client/src/layouts/ApiSupplemental.tsx +173 -0
  110. package/bin/mint/client/src/layouts/ContentsLayout.tsx +256 -0
  111. package/bin/mint/client/src/layouts/DocumentationLayout.tsx +44 -0
  112. package/bin/mint/client/src/layouts/OpenApiContent.tsx +301 -0
  113. package/bin/mint/client/src/layouts/SidebarLayout.tsx +412 -0
  114. package/bin/mint/client/src/layouts/UserFeedback.tsx +73 -0
  115. package/bin/mint/client/src/layouts/getGroupsInDivision.ts +25 -0
  116. package/bin/mint/client/src/layouts/isPathInGroupPages.ts +10 -0
  117. package/bin/mint/client/src/metadata.ts +58 -0
  118. package/bin/mint/client/src/nav.json +219 -0
  119. package/bin/mint/client/src/openapi.ts +3 -0
  120. package/bin/mint/client/src/pages/404.tsx +73 -0
  121. package/bin/mint/client/src/pages/_app.tsx +138 -0
  122. package/bin/mint/client/src/pages/_document.tsx +57 -0
  123. package/bin/mint/client/src/pages/api/issue.ts +10 -0
  124. package/bin/mint/client/src/pages/api/name.ts +8 -0
  125. package/bin/mint/client/src/pages/api/request.ts +31 -0
  126. package/bin/mint/client/src/pages/api/suggest.ts +10 -0
  127. package/bin/mint/client/src/pages/api/syntax-highlighted-json.ts +13 -0
  128. package/bin/mint/client/src/pages/api/utils.ts +6 -0
  129. package/bin/mint/client/src/pages/index.tsx +31 -0
  130. package/bin/mint/client/src/ui/Api.tsx +359 -0
  131. package/bin/mint/client/src/ui/Footer.tsx +124 -0
  132. package/bin/mint/client/src/ui/Header.tsx +370 -0
  133. package/bin/mint/client/src/ui/Logo.tsx +55 -0
  134. package/bin/mint/client/src/ui/PageHeader.tsx +51 -0
  135. package/bin/mint/client/src/ui/Search.tsx +386 -0
  136. package/bin/mint/client/src/ui/ThemeToggle.tsx +285 -0
  137. package/bin/mint/client/src/ui/Title.tsx +22 -0
  138. package/bin/mint/client/src/ui/TopLevelLink.tsx +122 -0
  139. package/bin/mint/client/src/utils/api.ts +252 -0
  140. package/bin/mint/client/src/utils/brands.ts +217 -0
  141. package/bin/mint/client/src/utils/castArray.ts +3 -0
  142. package/bin/mint/client/src/utils/childrenArray.ts +3 -0
  143. package/bin/mint/client/src/utils/fit.ts +27 -0
  144. package/bin/mint/client/src/utils/fontAwesome.ts +577 -0
  145. package/bin/mint/client/src/utils/getAnalyticsConfig.ts +14 -0
  146. package/bin/mint/client/src/utils/getLogoHref.ts +9 -0
  147. package/bin/mint/client/src/utils/getOpenApiContext.ts +26 -0
  148. package/bin/mint/client/src/utils/importAll.ts +6 -0
  149. package/bin/mint/client/src/utils/isObject.ts +3 -0
  150. package/bin/mint/client/src/utils/kebabToTitleCase.ts +3 -0
  151. package/bin/mint/client/src/utils/loadImage.ts +8 -0
  152. package/bin/mint/client/src/utils/slugToTitle.ts +7 -0
  153. package/bin/mint/client/src/utils/wait.ts +5 -0
  154. package/bin/mint/client/tailwind.config.cjs +323 -0
  155. package/bin/mint/client/test/test.test.ts +5 -0
  156. package/bin/mint/client/tsconfig.json +36 -0
  157. package/bin/mint/client/yarn.lock +9702 -0
  158. package/bin/scraping/site-scrapers/openNestedGitbookMenus.js +9 -28
  159. package/bin/scraping/site-scrapers/openNestedGitbookMenus.js.map +1 -1
  160. package/package.json +1 -1
  161. package/src/local-preview/index.ts +3 -1
  162. package/src/scraping/site-scrapers/openNestedGitbookMenus.ts +17 -42
  163. package/bin/local-preview/helper-commands/cleanCommand.js +0 -8
  164. package/bin/local-preview/helper-commands/cleanCommand.js.map +0 -1
package/README.md CHANGED
@@ -52,7 +52,9 @@ Note - `mintlify dev` requires `yarn` and it's recommended you install it as a g
52
52
 
53
53
  #### Troubleshooting
54
54
 
55
- - Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
55
+ Make sure you are using Node v18 or higher.
56
+
57
+ If Mintlify dev is still not running, run `mintlify install` to re-install dependencies.
56
58
 
57
59
  ### 🏃 Get Started
58
60
 
@@ -117,7 +117,7 @@ const dev = async () => {
117
117
  if (internet && gitInstalled) {
118
118
  shellExec("git config core.sparseCheckout true");
119
119
  shellExec('echo "client/" >> .git/info/sparse-checkout');
120
- pullOutput = shellExec("git pull mint-origin main").stdout;
120
+ pullOutput = shellExec("git pull mint-origin legacy-components-import").stdout;
121
121
  shellExec("git config core.sparseCheckout false");
122
122
  shellExec("rm .git/info/sparse-checkout");
123
123
  }
@@ -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,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"}
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,CACpB,+CAA+C,CAChD,CAAC,MAAM,CAAC;QACT,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"}
@@ -0,0 +1,94 @@
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
@@ -0,0 +1 @@
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"}
@@ -0,0 +1,5 @@
1
+ {
2
+ "fontawesome-svg-core": {
3
+ "license": "pro"
4
+ }
5
+ }
@@ -0,0 +1,4 @@
1
+ {
2
+ "presets": ["next/babel"],
3
+ "plugins": ["macros"]
4
+ }
@@ -0,0 +1,12 @@
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
@@ -0,0 +1,7 @@
1
+ {
2
+ "extends": "react-app",
3
+ "rules": {
4
+ "react/react-in-jsx-scope": "off",
5
+ "jsx-a11y/anchor-is-valid": "off"
6
+ }
7
+ }
@@ -0,0 +1,4 @@
1
+ **/*.mdx
2
+ **/generated/
3
+ src/samples/
4
+ **/snippet.*
@@ -0,0 +1,14 @@
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
+ }
@@ -0,0 +1,28 @@
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
+ }
@@ -0,0 +1,44 @@
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.
@@ -0,0 +1,195 @@
1
+ /*
2
+ * For a detailed explanation regarding each configuration property and type check, visit:
3
+ * https://jestjs.io/docs/configuration
4
+ */
5
+
6
+ export default {
7
+ // All imported modules in your tests should be mocked automatically
8
+ // automock: false,
9
+
10
+ // Stop running tests after `n` failures
11
+ // bail: 0,
12
+
13
+ // The directory where Jest should store its cached dependency information
14
+ // cacheDirectory: "/private/var/folders/k_/_vv6d9192pq13p60l40ts3440000gn/T/jest_dx",
15
+
16
+ // Automatically clear mock calls, instances, contexts and results before every test
17
+ // clearMocks: false,
18
+
19
+ // Indicates whether the coverage information should be collected while executing the test
20
+ // collectCoverage: false,
21
+
22
+ // An array of glob patterns indicating a set of files for which coverage information should be collected
23
+ // collectCoverageFrom: undefined,
24
+
25
+ // The directory where Jest should output its coverage files
26
+ // coverageDirectory: undefined,
27
+
28
+ // An array of regexp pattern strings used to skip coverage collection
29
+ // coveragePathIgnorePatterns: [
30
+ // "/node_modules/"
31
+ // ],
32
+
33
+ // Indicates which provider should be used to instrument code for coverage
34
+ coverageProvider: "v8",
35
+
36
+ // A list of reporter names that Jest uses when writing coverage reports
37
+ // coverageReporters: [
38
+ // "json",
39
+ // "text",
40
+ // "lcov",
41
+ // "clover"
42
+ // ],
43
+
44
+ // An object that configures minimum threshold enforcement for coverage results
45
+ // coverageThreshold: undefined,
46
+
47
+ // A path to a custom dependency extractor
48
+ // dependencyExtractor: undefined,
49
+
50
+ // Make calling deprecated APIs throw helpful error messages
51
+ // errorOnDeprecated: false,
52
+
53
+ // The default configuration for fake timers
54
+ // fakeTimers: {
55
+ // "enableGlobally": false
56
+ // },
57
+
58
+ // Force coverage collection from ignored files using an array of glob patterns
59
+ // forceCoverageMatch: [],
60
+
61
+ // A path to a module which exports an async function that is triggered once before all test suites
62
+ // globalSetup: undefined,
63
+
64
+ // A path to a module which exports an async function that is triggered once after all test suites
65
+ // globalTeardown: undefined,
66
+
67
+ // A set of global variables that need to be available in all test environments
68
+ // globals: {},
69
+
70
+ // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
71
+ // maxWorkers: "50%",
72
+
73
+ // An array of directory names to be searched recursively up from the requiring module's location
74
+ // moduleDirectories: [
75
+ // "node_modules"
76
+ // ],
77
+
78
+ // An array of file extensions your modules use
79
+ // moduleFileExtensions: [
80
+ // "js",
81
+ // "mjs",
82
+ // "cjs",
83
+ // "jsx",
84
+ // "ts",
85
+ // "tsx",
86
+ // "json",
87
+ // "node"
88
+ // ],
89
+
90
+ // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
91
+ // moduleNameMapper: {},
92
+
93
+ // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
94
+ // modulePathIgnorePatterns: [],
95
+
96
+ // Activates notifications for test results
97
+ // notify: false,
98
+
99
+ // An enum that specifies notification mode. Requires { notify: true }
100
+ // notifyMode: "failure-change",
101
+
102
+ // A preset that is used as a base for Jest's configuration
103
+ // preset: undefined,
104
+
105
+ // Run tests from one or more projects
106
+ // projects: undefined,
107
+
108
+ // Use this configuration option to add custom reporters to Jest
109
+ // reporters: undefined,
110
+
111
+ // Automatically reset mock state before every test
112
+ // resetMocks: false,
113
+
114
+ // Reset the module registry before running each individual test
115
+ // resetModules: false,
116
+
117
+ // A path to a custom resolver
118
+ // resolver: undefined,
119
+
120
+ // Automatically restore mock state and implementation before every test
121
+ // restoreMocks: false,
122
+
123
+ // The root directory that Jest should scan for tests and modules within
124
+ // rootDir: undefined,
125
+
126
+ // A list of paths to directories that Jest should use to search for files in
127
+ // roots: [
128
+ // "<rootDir>"
129
+ // ],
130
+
131
+ // Allows you to use a custom runner instead of Jest's default test runner
132
+ // runner: "jest-runner",
133
+
134
+ // The paths to modules that run some code to configure or set up the testing environment before each test
135
+ // setupFiles: [],
136
+
137
+ // A list of paths to modules that run some code to configure or set up the testing framework before each test
138
+ // setupFilesAfterEnv: [],
139
+
140
+ // The number of seconds after which a test is considered as slow and reported as such in the results.
141
+ // slowTestThreshold: 5,
142
+
143
+ // A list of paths to snapshot serializer modules Jest should use for snapshot testing
144
+ // snapshotSerializers: [],
145
+
146
+ // The test environment that will be used for testing
147
+ // testEnvironment: "jest-environment-node",
148
+
149
+ // Options that will be passed to the testEnvironment
150
+ // testEnvironmentOptions: {},
151
+
152
+ // Adds a location field to test results
153
+ // testLocationInResults: false,
154
+
155
+ // The glob patterns Jest uses to detect test files
156
+ // testMatch: [
157
+ // "**/__tests__/**/*.[jt]s?(x)",
158
+ // "**/?(*.)+(spec|test).[tj]s?(x)"
159
+ // ],
160
+
161
+ // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
162
+ // testPathIgnorePatterns: [
163
+ // "/node_modules/"
164
+ // ],
165
+
166
+ // The regexp pattern or array of patterns that Jest uses to detect test files
167
+ // testRegex: [],
168
+
169
+ // This option allows the use of a custom results processor
170
+ // testResultsProcessor: undefined,
171
+
172
+ // This option allows use of a custom test runner
173
+ // testRunner: "jest-circus/runner",
174
+
175
+ // A map from regular expressions to paths to transformers
176
+ // transform: undefined,
177
+
178
+ // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
179
+ // transformIgnorePatterns: [
180
+ // "/node_modules/",
181
+ // "\\.pnp\\.[^\\/]+$"
182
+ // ],
183
+
184
+ // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
185
+ // unmockedModulePathPatterns: undefined,
186
+
187
+ // Indicates whether each individual test should be reported during the run
188
+ // verbose: undefined,
189
+
190
+ // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
191
+ // watchPathIgnorePatterns: [],
192
+
193
+ // Whether to use watchman for file crawling
194
+ // watchman: true,
195
+ };
@@ -0,0 +1,4 @@
1
+ /// <reference types="next" />
2
+
3
+ // NOTE: This file should not be edited
4
+ // see https://nextjs.org/docs/basic-features/typescript for more information.
@@ -0,0 +1,152 @@
1
+ import { withSentryConfig } from '@sentry/nextjs';
2
+ import withLinkRoles from './rehype/withLinkRoles.js';
3
+ import { createLoader } from 'simple-functional-loader';
4
+ import frontMatter from 'front-matter';
5
+ import withSmartypants from 'remark-smartypants';
6
+ import withTableOfContents from './remark/withTableOfContents.js';
7
+ import withCodeBlocks from './rehype/withCodeBlocks.js';
8
+ import withNextLinks from './remark/withNextLinks.js';
9
+ import withFrames from './remark/withFrames.js';
10
+ import withImportsInjected from './remark/withImportsInjected.js';
11
+ import BundleAnalyzer from '@next/bundle-analyzer';
12
+ import remarkGfm from 'remark-gfm';
13
+ import withStaticProps from './rehype/withStaticProps.js';
14
+ import withApiComponents from './rehype/withApiComponents.js';
15
+ import withRawComponents from './rehype/withRawComponents.js';
16
+ import mintConfig from './src/mint.json' assert { type: 'json' };
17
+ import withSyntaxHighlighting from './rehype/withSyntaxHighlighting.js';
18
+ import withLayouts from './rehype/withLayouts.js';
19
+ import { potentiallyRemoveEndMatter } from './prebuild/injectNav.js';
20
+
21
+ const withBundleAnalyzer = BundleAnalyzer({
22
+ enabled: process.env.ANALYZE === 'true',
23
+ });
24
+
25
+ const sentryWebpackPluginOptions = {
26
+ // Suppresses all logs
27
+ silent: true,
28
+
29
+ // Disable sentry builds when we don't have a sentry auth token.
30
+ // Sites have to be manually added to our Sentry tracking so by default
31
+ // new customers' sites will not have an auth token set.
32
+ dryRun: process.env.VERCEL_ENV !== 'production' || !process.env.SENTRY_AUTH_TOKEN,
33
+ };
34
+
35
+ export default withSentryConfig(
36
+ withBundleAnalyzer({
37
+ swcMinify: true,
38
+ pageExtensions: ['js', 'jsx', 'mdx', 'ts', 'tsx', 'md'],
39
+ images: {
40
+ disableStaticImages: true,
41
+ },
42
+ basePath: mintConfig?.basePath,
43
+ webpack(config, options) {
44
+ config.module.rules.push({
45
+ test: /\.(png|jpe?g|gif|webp|avif|mp4)$/i,
46
+ issuer: /\.(jsx?|tsx?|mdx?)$/,
47
+ use: [
48
+ {
49
+ loader: 'file-loader',
50
+ options: {
51
+ publicPath: '/_next',
52
+ name: 'static/media/[name].[hash].[ext]',
53
+ },
54
+ },
55
+ ],
56
+ });
57
+
58
+ config.module.rules.push({
59
+ test: /\.svg$/,
60
+ use: [
61
+ {
62
+ loader: '@svgr/webpack',
63
+ options: { svgoConfig: { plugins: { removeViewBox: false } } },
64
+ },
65
+ {
66
+ loader: 'file-loader',
67
+ options: {
68
+ publicPath: '/_next',
69
+ name: 'static/media/[name].[hash].[ext]',
70
+ },
71
+ },
72
+ ],
73
+ });
74
+
75
+ config.module.rules.push({
76
+ test: { and: [/\.mdx$/, /snippets/] },
77
+ use: [
78
+ options.defaultLoaders.babel,
79
+ {
80
+ loader: '@mdx-js/loader',
81
+ options: {
82
+ providerImportSource: '@mdx-js/react',
83
+ remarkPlugins: [
84
+ remarkGfm,
85
+ withImportsInjected,
86
+ withFrames,
87
+ withNextLinks,
88
+ withSmartypants,
89
+ ],
90
+ rehypePlugins: [
91
+ [
92
+ withSyntaxHighlighting,
93
+ {
94
+ ignoreMissing: true,
95
+ },
96
+ ],
97
+ withCodeBlocks,
98
+ withLinkRoles,
99
+ ],
100
+ },
101
+ },
102
+ ],
103
+ });
104
+
105
+ config.module.rules.push({
106
+ test: { and: [/\.mdx?$/], not: [/snippets/] },
107
+ use: [
108
+ options.defaultLoaders.babel,
109
+ {
110
+ loader: '@mdx-js/loader',
111
+ options: {
112
+ providerImportSource: '@mdx-js/react',
113
+ remarkPlugins: [
114
+ remarkGfm,
115
+ withImportsInjected,
116
+ withFrames,
117
+ withTableOfContents,
118
+ withNextLinks,
119
+ withSmartypants,
120
+ ],
121
+ rehypePlugins: [
122
+ [
123
+ withSyntaxHighlighting,
124
+ {
125
+ ignoreMissing: true,
126
+ },
127
+ ],
128
+ withCodeBlocks,
129
+ withLinkRoles,
130
+ withApiComponents,
131
+ withRawComponents,
132
+ [
133
+ withStaticProps,
134
+ `{
135
+ isMdx: true
136
+ }`,
137
+ ],
138
+ withLayouts
139
+ ],
140
+ },
141
+ },
142
+ createLoader(function (source) {
143
+ const { body } = frontMatter(source);
144
+ return potentiallyRemoveEndMatter(body);
145
+ }),
146
+ ],
147
+ });
148
+ return config;
149
+ },
150
+ }),
151
+ sentryWebpackPluginOptions
152
+ );