mintlify 1.0.6 → 1.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -3
- package/bin/browser.js +24 -0
- package/bin/browser.js.map +1 -0
- package/bin/constants.js +8 -0
- package/bin/constants.js.map +1 -0
- package/bin/dev/getOpenApiContext.js +46 -0
- package/bin/dev/getOpenApiContext.js.map +1 -0
- package/bin/dev/index.js +164 -0
- package/bin/dev/index.js.map +1 -0
- package/bin/dev/injectNav.js +97 -0
- package/bin/dev/injectNav.js.map +1 -0
- package/bin/dev/slugToTitle.js +8 -0
- package/bin/dev/slugToTitle.js.map +1 -0
- package/bin/downloadImage.js +27 -0
- package/bin/downloadImage.js.map +1 -0
- package/bin/index.js +49 -106
- package/bin/index.js.map +1 -1
- package/bin/init-command/index.js +51 -0
- package/bin/init-command/index.js.map +1 -0
- package/bin/init-command/templates.js +41 -0
- package/bin/init-command/templates.js.map +1 -0
- package/bin/local-preview/categorizeFiles.js +56 -0
- package/bin/local-preview/categorizeFiles.js.map +1 -0
- package/bin/local-preview/getOpenApiContext.js +46 -0
- package/bin/local-preview/getOpenApiContext.js.map +1 -0
- package/bin/local-preview/index.js +138 -0
- package/bin/local-preview/index.js.map +1 -0
- package/bin/local-preview/injectFavicons.js +72 -0
- package/bin/local-preview/injectFavicons.js.map +1 -0
- package/bin/local-preview/listener.js +112 -0
- package/bin/local-preview/listener.js.map +1 -0
- package/bin/local-preview/metadata.js +121 -0
- package/bin/local-preview/metadata.js.map +1 -0
- package/bin/local-preview/mintConfigFile.js +43 -0
- package/bin/local-preview/mintConfigFile.js.map +1 -0
- package/bin/local-preview/openApiCheck.js +16 -0
- package/bin/local-preview/openApiCheck.js.map +1 -0
- package/bin/local-preview/slugToTitle.js +8 -0
- package/bin/local-preview/slugToTitle.js.map +1 -0
- package/bin/mint/client/.babel-plugin-macrosrc.json +5 -0
- package/bin/mint/client/.babelrc +4 -0
- package/bin/mint/client/.editorconfig +12 -0
- package/bin/mint/client/.eslintrc.json +7 -0
- package/bin/mint/client/.prettierignore +4 -0
- package/bin/mint/client/.prettierrc +14 -0
- package/bin/mint/client/.vscode/launch.json +28 -0
- package/bin/mint/client/README.md +46 -0
- package/bin/mint/client/jest.config.ts +195 -0
- package/bin/mint/client/next-env.d.ts +4 -0
- package/bin/mint/client/next.config.js +152 -0
- package/bin/mint/client/package.json +140 -0
- package/bin/mint/client/postcss.config.cjs +9 -0
- package/bin/mint/client/prebuild/faviconConfig.js +35 -0
- package/bin/mint/client/prebuild/getOpenApiContext.js +53 -0
- package/bin/mint/client/prebuild/index.js +117 -0
- package/bin/mint/client/prebuild/injectNav.js +115 -0
- package/bin/mint/client/prebuild/slugToTitle.js +7 -0
- package/bin/mint/client/rehype/withApiComponents.js +60 -0
- package/bin/mint/client/rehype/withCodeBlocks.js +54 -0
- package/bin/mint/client/rehype/withLayouts.js +113 -0
- package/bin/mint/client/rehype/withLinkRoles.js +13 -0
- package/bin/mint/client/rehype/withRawComponents.js +13 -0
- package/bin/mint/client/rehype/withStaticProps.js +25 -0
- package/bin/mint/client/rehype/withSyntaxHighlighting.js +60 -0
- package/bin/mint/client/remark/utils.js +369 -0
- package/bin/mint/client/remark/withFrames.js +55 -0
- package/bin/mint/client/remark/withImportsInjected.js +36 -0
- package/bin/mint/client/remark/withNextLinks.js +37 -0
- package/bin/mint/client/remark/withTableOfContents.js +71 -0
- package/bin/mint/client/scripts/local-to-docs.js +72 -0
- package/bin/mint/client/scripts/local.js +177 -0
- package/bin/mint/client/sentry.client.config.js +15 -0
- package/bin/mint/client/sentry.properties +4 -0
- package/bin/mint/client/sentry.server.config.js +15 -0
- package/bin/mint/client/src/analytics/AbstractAnalyticsImplementation.ts +50 -0
- package/bin/mint/client/src/analytics/AnalyticsContext.ts +5 -0
- package/bin/mint/client/src/analytics/AnalyticsMediator.ts +101 -0
- package/bin/mint/client/src/analytics/FakeAnalyticsMediator.ts +9 -0
- package/bin/mint/client/src/analytics/GA4Script.tsx +33 -0
- package/bin/mint/client/src/analytics/implementations/amplitude.ts +26 -0
- package/bin/mint/client/src/analytics/implementations/fathom.ts +38 -0
- package/bin/mint/client/src/analytics/implementations/ga4.ts +33 -0
- package/bin/mint/client/src/analytics/implementations/hotjar.ts +53 -0
- package/bin/mint/client/src/analytics/implementations/mixpanel-browser.d.ts +1 -0
- package/bin/mint/client/src/analytics/implementations/mixpanel.ts +52 -0
- package/bin/mint/client/src/analytics/implementations/posthog.ts +37 -0
- package/bin/mint/client/src/components/Accordion/Accordion.tsx +43 -0
- package/bin/mint/client/src/components/Accordion/index.ts +4 -0
- package/bin/mint/client/src/components/ApiExample.tsx +9 -0
- package/bin/mint/client/src/components/Card.tsx +51 -0
- package/bin/mint/client/src/components/CodeGroup.tsx +132 -0
- package/bin/mint/client/src/components/Editor.tsx +12 -0
- package/bin/mint/client/src/components/Expandable.tsx +40 -0
- package/bin/mint/client/src/components/Heading.tsx +84 -0
- package/bin/mint/client/src/components/Param.tsx +56 -0
- package/bin/mint/client/src/components/Request.tsx +19 -0
- package/bin/mint/client/src/components/ResponseField.tsx +33 -0
- package/bin/mint/client/src/components/TabBar.tsx +61 -0
- package/bin/mint/client/src/config.ts +115 -0
- package/bin/mint/client/src/css/bar-of-progress.css +10 -0
- package/bin/mint/client/src/css/base.css +29 -0
- package/bin/mint/client/src/css/font-awesome.css +7 -0
- package/bin/mint/client/src/css/fonts.css +44 -0
- package/bin/mint/client/src/css/main.css +11 -0
- package/bin/mint/client/src/css/prism.css +270 -0
- package/bin/mint/client/src/css/utilities.css +43 -0
- package/bin/mint/client/src/enums/components.ts +8 -0
- package/bin/mint/client/src/fonts/FiraCode-VF.woff +0 -0
- package/bin/mint/client/src/fonts/FiraCode-VF.woff2 +0 -0
- package/bin/mint/client/src/fonts/IBMPlexMono-Regular.ttf +0 -0
- package/bin/mint/client/src/fonts/IBMPlexMono-SemiBold.ttf +0 -0
- package/bin/mint/client/src/fonts/Inter-italic-latin.var.woff2 +0 -0
- package/bin/mint/client/src/fonts/Inter-roman-latin.var.woff2 +0 -0
- package/bin/mint/client/src/fonts/Pally-Variable.ttf +0 -0
- package/bin/mint/client/src/fonts/SourceSansPro-Regular.otf +0 -0
- package/bin/mint/client/src/fonts/SourceSerifPro-Regular.ttf +0 -0
- package/bin/mint/client/src/fonts/Synonym-Variable.ttf +0 -0
- package/bin/mint/client/src/fonts/Ubuntu-Mono-bold.woff2 +0 -0
- package/bin/mint/client/src/fonts/generated/IBMPlexMono-Regular-subset.woff2 +0 -0
- package/bin/mint/client/src/fonts/generated/IBMPlexMono-Regular-subset.zopfli.woff +0 -0
- package/bin/mint/client/src/fonts/generated/IBMPlexMono-Regular.module.css +11 -0
- package/bin/mint/client/src/fonts/generated/IBMPlexMono-SemiBold-subset.woff2 +0 -0
- package/bin/mint/client/src/fonts/generated/IBMPlexMono-SemiBold-subset.zopfli.woff +0 -0
- package/bin/mint/client/src/fonts/generated/IBMPlexMono-SemiBold.module.css +11 -0
- package/bin/mint/client/src/fonts/generated/Pally-Variable-subset.woff2 +0 -0
- package/bin/mint/client/src/fonts/generated/Pally-Variable-subset.zopfli.woff +0 -0
- package/bin/mint/client/src/fonts/generated/Pally-Variable.module.css +11 -0
- package/bin/mint/client/src/fonts/generated/SourceSerifPro-Regular-subset.woff2 +0 -0
- package/bin/mint/client/src/fonts/generated/SourceSerifPro-Regular-subset.zopfli.woff +0 -0
- package/bin/mint/client/src/fonts/generated/SourceSerifPro-Regular.module.css +11 -0
- package/bin/mint/client/src/fonts/generated/Synonym-Variable-subset.woff2 +0 -0
- package/bin/mint/client/src/fonts/generated/Synonym-Variable-subset.zopfli.woff +0 -0
- package/bin/mint/client/src/fonts/generated/Synonym-Variable.module.css +11 -0
- package/bin/mint/client/src/fonts/generated/TenorSans-Regular-subset.woff2 +0 -0
- package/bin/mint/client/src/fonts/generated/TenorSans-Regular-subset.zopfli.woff +0 -0
- package/bin/mint/client/src/fonts/generated/TenorSans-Regular.module.css +11 -0
- package/bin/mint/client/src/hooks/useActionKey.ts +20 -0
- package/bin/mint/client/src/hooks/useIsomorphicLayoutEffect.ts +3 -0
- package/bin/mint/client/src/hooks/useMedia.ts +27 -0
- package/bin/mint/client/src/hooks/usePrevNext.ts +34 -0
- package/bin/mint/client/src/hooks/useTop.ts +15 -0
- package/bin/mint/client/src/icons/CopyToClipboard.tsx +33 -0
- package/bin/mint/client/src/index.d.ts +1 -0
- package/bin/mint/client/src/layouts/ApiSupplemental.tsx +173 -0
- package/bin/mint/client/src/layouts/ContentsLayout.tsx +256 -0
- package/bin/mint/client/src/layouts/DocumentationLayout.tsx +44 -0
- package/bin/mint/client/src/layouts/OpenApiContent.tsx +301 -0
- package/bin/mint/client/src/layouts/SidebarLayout.tsx +412 -0
- package/bin/mint/client/src/layouts/UserFeedback.tsx +73 -0
- package/bin/mint/client/src/layouts/getGroupsInDivision.ts +25 -0
- package/bin/mint/client/src/layouts/isPathInGroupPages.ts +10 -0
- package/bin/mint/client/src/metadata.ts +58 -0
- package/bin/mint/client/src/openapi.ts +3 -0
- package/bin/mint/client/src/pages/404.tsx +73 -0
- package/bin/mint/client/src/pages/_app.tsx +138 -0
- package/bin/mint/client/src/pages/_document.tsx +57 -0
- package/bin/mint/client/src/pages/api/issue.ts +10 -0
- package/bin/mint/client/src/pages/api/name.ts +8 -0
- package/bin/mint/client/src/pages/api/request.ts +31 -0
- package/bin/mint/client/src/pages/api/suggest.ts +10 -0
- package/bin/mint/client/src/pages/api/syntax-highlighted-json.ts +13 -0
- package/bin/mint/client/src/pages/api/utils.ts +6 -0
- package/bin/mint/client/src/pages/index.tsx +31 -0
- package/bin/mint/client/src/ui/Api.tsx +359 -0
- package/bin/mint/client/src/ui/Footer.tsx +124 -0
- package/bin/mint/client/src/ui/Header.tsx +370 -0
- package/bin/mint/client/src/ui/Logo.tsx +55 -0
- package/bin/mint/client/src/ui/PageHeader.tsx +51 -0
- package/bin/mint/client/src/ui/Search.tsx +386 -0
- package/bin/mint/client/src/ui/ThemeToggle.tsx +285 -0
- package/bin/mint/client/src/ui/Title.tsx +22 -0
- package/bin/mint/client/src/ui/TopLevelLink.tsx +122 -0
- package/bin/mint/client/src/utils/api.ts +252 -0
- package/bin/mint/client/src/utils/brands.ts +217 -0
- package/bin/mint/client/src/utils/castArray.ts +3 -0
- package/bin/mint/client/src/utils/childrenArray.ts +3 -0
- package/bin/mint/client/src/utils/fit.ts +27 -0
- package/bin/mint/client/src/utils/fontAwesome.ts +577 -0
- package/bin/mint/client/src/utils/getAnalyticsConfig.ts +14 -0
- package/bin/mint/client/src/utils/getLogoHref.ts +9 -0
- package/bin/mint/client/src/utils/getOpenApiContext.ts +26 -0
- package/bin/mint/client/src/utils/importAll.ts +6 -0
- package/bin/mint/client/src/utils/isObject.ts +3 -0
- package/bin/mint/client/src/utils/kebabToTitleCase.ts +3 -0
- package/bin/mint/client/src/utils/loadImage.ts +8 -0
- package/bin/mint/client/src/utils/slugToTitle.ts +7 -0
- package/bin/mint/client/src/utils/wait.ts +5 -0
- package/bin/mint/client/tailwind.config.cjs +323 -0
- package/bin/mint/client/test/test.test.ts +5 -0
- package/bin/mint/client/tsconfig.json +36 -0
- package/bin/mint/client/yarn.lock +9702 -0
- package/bin/navigation.js +4 -0
- package/bin/navigation.js.map +1 -0
- package/bin/pageTemplate.js +30 -0
- package/bin/pageTemplate.js.map +1 -0
- package/bin/scraping/combineNavWithEmptyGroupTitles.js +20 -0
- package/bin/scraping/combineNavWithEmptyGroupTitles.js.map +1 -0
- package/bin/scraping/detectFramework.js +25 -0
- package/bin/scraping/detectFramework.js.map +1 -0
- package/bin/scraping/downloadAllImages.js +57 -0
- package/bin/scraping/downloadAllImages.js.map +1 -0
- package/bin/scraping/getSitemapLinks.js +18 -0
- package/bin/scraping/getSitemapLinks.js.map +1 -0
- package/bin/scraping/replaceImagePaths.js +17 -0
- package/bin/scraping/replaceImagePaths.js.map +1 -0
- package/bin/scraping/scrapeFileGettingFileNameFromUrl.js +43 -0
- package/bin/scraping/scrapeFileGettingFileNameFromUrl.js.map +1 -0
- package/bin/scraping/scrapeGettingFileNameFromUrl.js +14 -0
- package/bin/scraping/scrapeGettingFileNameFromUrl.js.map +1 -0
- package/bin/scraping/scrapePage.js +9 -0
- package/bin/scraping/scrapePage.js.map +1 -0
- package/bin/scraping/scrapePageCommands.js +48 -0
- package/bin/scraping/scrapePageCommands.js.map +1 -0
- package/bin/scraping/scrapeSection.js +9 -0
- package/bin/scraping/scrapeSection.js.map +1 -0
- package/bin/scraping/scrapeSectionCommands.js +90 -0
- package/bin/scraping/scrapeSectionCommands.js.map +1 -0
- package/bin/scraping/site-scrapers/getLinksRecursively.js +33 -0
- package/bin/scraping/site-scrapers/getLinksRecursively.js.map +1 -0
- package/bin/scraping/site-scrapers/scrapeDocusaurusPage.js +43 -0
- package/bin/scraping/site-scrapers/scrapeDocusaurusPage.js.map +1 -0
- package/bin/scraping/site-scrapers/scrapeDocusaurusSection.js +52 -0
- package/bin/scraping/site-scrapers/scrapeDocusaurusSection.js.map +1 -0
- package/bin/{scrapeGitBookPage.js → scraping/site-scrapers/scrapeGitBookPage.js} +10 -5
- package/bin/scraping/site-scrapers/scrapeGitBookPage.js.map +1 -0
- package/bin/scraping/site-scrapers/scrapeGitBookSection.js +51 -0
- package/bin/scraping/site-scrapers/scrapeGitBookSection.js.map +1 -0
- package/bin/scraping/site-scrapers/scrapeReadMePage.js +35 -0
- package/bin/scraping/site-scrapers/scrapeReadMePage.js.map +1 -0
- package/bin/scraping/site-scrapers/scrapeReadMeSection.js +38 -0
- package/bin/scraping/site-scrapers/scrapeReadMeSection.js.map +1 -0
- package/bin/util.js +47 -8
- package/bin/util.js.map +1 -1
- package/bin/validation/isValidLink.js +11 -0
- package/bin/validation/isValidLink.js.map +1 -0
- package/bin/validation/stopIfInvalidLink.js +9 -0
- package/bin/validation/stopIfInvalidLink.js.map +1 -0
- package/package.json +21 -4
- package/src/browser.ts +24 -0
- package/src/constants.ts +10 -0
- package/src/downloadImage.ts +35 -0
- package/src/index.ts +111 -122
- package/src/init-command/index.ts +59 -0
- package/src/{templates.ts → init-command/templates.ts} +0 -0
- package/src/local-preview/categorizeFiles.ts +74 -0
- package/src/local-preview/getOpenApiContext.ts +61 -0
- package/src/local-preview/index.ts +164 -0
- package/src/local-preview/injectFavicons.ts +76 -0
- package/src/local-preview/listener.ts +116 -0
- package/src/local-preview/metadata.ts +154 -0
- package/src/local-preview/mintConfigFile.ts +48 -0
- package/src/local-preview/openApiCheck.ts +19 -0
- package/src/local-preview/slugToTitle.ts +7 -0
- package/src/navigation.ts +12 -0
- package/src/pageTemplate.ts +32 -0
- package/src/scraping/combineNavWithEmptyGroupTitles.ts +21 -0
- package/src/scraping/detectFramework.ts +31 -0
- package/src/scraping/downloadAllImages.ts +79 -0
- package/src/scraping/getSitemapLinks.ts +18 -0
- package/src/scraping/replaceImagePaths.ts +21 -0
- package/src/scraping/scrapeFileGettingFileNameFromUrl.ts +81 -0
- package/src/scraping/scrapeGettingFileNameFromUrl.ts +50 -0
- package/src/scraping/scrapePage.ts +24 -0
- package/src/scraping/scrapePageCommands.ts +52 -0
- package/src/scraping/scrapeSection.ts +16 -0
- package/src/scraping/scrapeSectionCommands.ts +110 -0
- package/src/scraping/site-scrapers/getLinksRecursively.ts +40 -0
- package/src/scraping/site-scrapers/scrapeDocusaurusPage.ts +67 -0
- package/src/scraping/site-scrapers/scrapeDocusaurusSection.ts +80 -0
- package/src/{scrapeGitBookPage.ts → scraping/site-scrapers/scrapeGitBookPage.ts} +25 -5
- package/src/scraping/site-scrapers/scrapeGitBookSection.ts +77 -0
- package/src/scraping/site-scrapers/scrapeReadMePage.ts +57 -0
- package/src/scraping/site-scrapers/scrapeReadMeSection.ts +60 -0
- package/src/util.ts +53 -7
- package/src/validation/isValidLink.ts +9 -0
- package/src/validation/stopIfInvalidLink.ts +9 -0
- package/tsconfig.json +1 -1
- package/bin/scrapeGitBook.js +0 -28
- package/bin/scrapeGitBook.js.map +0 -1
- package/bin/scrapeGitBookPage.js.map +0 -1
- package/bin/scrapeReadMe.js +0 -60
- package/bin/scrapeReadMe.js.map +0 -1
- package/bin/scrapeReadMePage.js +0 -28
- package/bin/scrapeReadMePage.js.map +0 -1
- package/src/scrapeReadMe.ts +0 -79
- package/src/scrapeReadMePage.ts +0 -37
package/README.md
CHANGED
|
@@ -1,7 +1,31 @@
|
|
|
1
1
|
# Mintlify CLI
|
|
2
2
|
|
|
3
|
+
The Mintlify CLI is used to automate migrations.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
`npm i -g mintlify`
|
|
8
|
+
|
|
9
|
+
If you installed a local version, you may need to uninstall it with
|
|
10
|
+
|
|
11
|
+
`npm uninstall -g mintlify` before installing the published version.
|
|
12
|
+
|
|
13
|
+
## Local development & testing
|
|
14
|
+
|
|
3
15
|
To test changes locally run:
|
|
4
16
|
|
|
5
|
-
`npm run
|
|
6
|
-
|
|
7
|
-
|
|
17
|
+
`npm run local`
|
|
18
|
+
|
|
19
|
+
## Commands
|
|
20
|
+
|
|
21
|
+
### Migrations
|
|
22
|
+
|
|
23
|
+
We support automated migrations from ReadMe, GitBook, and Docusaurus.
|
|
24
|
+
|
|
25
|
+
`mintlify scrape-page <url>` - Scrapes the page at the URL provided and creates a corresponding MDX file
|
|
26
|
+
|
|
27
|
+
`mintlify scrape-section <url>` - Scrapes the section at the URL provided and creates the MDX files within that section
|
|
28
|
+
|
|
29
|
+
#### Options
|
|
30
|
+
|
|
31
|
+
`--overwrite` - By default if an existing file with the same path name is detected, the file will not be overwritten by the scraper. Use this option to force an overwrite.
|
package/bin/browser.js
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { launch } from "puppeteer";
|
|
2
|
+
export async function startBrowser() {
|
|
3
|
+
try {
|
|
4
|
+
return await launch({
|
|
5
|
+
headless: true,
|
|
6
|
+
ignoreHTTPSErrors: true,
|
|
7
|
+
});
|
|
8
|
+
}
|
|
9
|
+
catch (err) {
|
|
10
|
+
console.log("Could not create a browser instance: ", err);
|
|
11
|
+
process.exit(1);
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
|
+
export async function getHtmlWithPuppeteer(href) {
|
|
15
|
+
const browser = await startBrowser();
|
|
16
|
+
const page = await browser.newPage();
|
|
17
|
+
await page.goto(href, {
|
|
18
|
+
waitUntil: "networkidle2",
|
|
19
|
+
});
|
|
20
|
+
const html = await page.content();
|
|
21
|
+
browser.close();
|
|
22
|
+
return html;
|
|
23
|
+
}
|
|
24
|
+
//# sourceMappingURL=browser.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"browser.js","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,MAAM,CAAC,KAAK,UAAU,YAAY;IAChC,IAAI;QACF,OAAO,MAAM,MAAM,CAAC;YAClB,QAAQ,EAAE,IAAI;YACd,iBAAiB,EAAE,IAAI;SACxB,CAAC,CAAC;KACJ;IAAC,OAAO,GAAG,EAAE;QACZ,OAAO,CAAC,GAAG,CAAC,uCAAuC,EAAE,GAAG,CAAC,CAAC;QAC1D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,IAAY;IACrD,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;IACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IAClC,OAAO,CAAC,KAAK,EAAE,CAAC;IAChB,OAAO,IAAI,CAAC;AACd,CAAC"}
|
package/bin/constants.js
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import path from "path";
|
|
2
|
+
import * as url from "url";
|
|
3
|
+
// package installation location
|
|
4
|
+
export const INSTALL_PATH = url.fileURLToPath(new URL(".", import.meta.url));
|
|
5
|
+
// command execution location
|
|
6
|
+
export const CMD_EXEC_PATH = process.cwd();
|
|
7
|
+
export const CLIENT_PATH = path.join(INSTALL_PATH, "mint", "client");
|
|
8
|
+
//# sourceMappingURL=constants.js.map
|
|
@@ -0,0 +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;AAE3B,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,6BAA6B;AAC7B,MAAM,CAAC,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;AAE3C,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC"}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
export const extractMethodAndEndpoint = (api) => {
|
|
2
|
+
const methodRegex = /^get|post|put|delete|patch/i;
|
|
3
|
+
const trimmed = api.trim();
|
|
4
|
+
const foundMethod = trimmed.match(methodRegex);
|
|
5
|
+
const endIndexOfMethod = foundMethod
|
|
6
|
+
? api.indexOf(foundMethod[0]) + foundMethod[0].length
|
|
7
|
+
: 0;
|
|
8
|
+
return {
|
|
9
|
+
method: foundMethod ? foundMethod[0].toUpperCase() : undefined,
|
|
10
|
+
endpoint: api.substring(endIndexOfMethod).trim(),
|
|
11
|
+
};
|
|
12
|
+
};
|
|
13
|
+
export const getOpenApiOperationMethodAndEndpoint = (openApiObj, openApiMetaField) => {
|
|
14
|
+
const { endpoint, method } = extractMethodAndEndpoint(openApiMetaField);
|
|
15
|
+
const path = (openApiObj === null || openApiObj === void 0 ? void 0 : openApiObj.paths) && openApiObj.paths[endpoint];
|
|
16
|
+
if (path == null) {
|
|
17
|
+
return {};
|
|
18
|
+
}
|
|
19
|
+
let operation;
|
|
20
|
+
if (method) {
|
|
21
|
+
operation = path[method.toLowerCase()];
|
|
22
|
+
}
|
|
23
|
+
else {
|
|
24
|
+
const firstOperationKey = Object.keys(path)[0];
|
|
25
|
+
operation = path[firstOperationKey];
|
|
26
|
+
}
|
|
27
|
+
return {
|
|
28
|
+
operation,
|
|
29
|
+
method,
|
|
30
|
+
endpoint,
|
|
31
|
+
};
|
|
32
|
+
};
|
|
33
|
+
export const getOpenApiTitleAndDescription = (openApiObj, openApiMetaField) => {
|
|
34
|
+
if (openApiObj == null || !openApiMetaField || openApiMetaField == null) {
|
|
35
|
+
return {};
|
|
36
|
+
}
|
|
37
|
+
const { operation } = getOpenApiOperationMethodAndEndpoint(openApiObj, openApiMetaField);
|
|
38
|
+
if (operation == null) {
|
|
39
|
+
return {};
|
|
40
|
+
}
|
|
41
|
+
return {
|
|
42
|
+
title: operation.summary,
|
|
43
|
+
description: operation.description,
|
|
44
|
+
};
|
|
45
|
+
};
|
|
46
|
+
//# sourceMappingURL=getOpenApiContext.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"getOpenApiContext.js","sourceRoot":"","sources":["../../src/dev/getOpenApiContext.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,GAAG,EAAE,EAAE;IAC9C,MAAM,WAAW,GAAG,6BAA6B,CAAC;IAClD,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;IAC3B,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAE/C,MAAM,gBAAgB,GAAG,WAAW;QAClC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM;QACrD,CAAC,CAAC,CAAC,CAAC;IAEN,OAAO;QACL,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS;QAC9D,QAAQ,EAAE,GAAG,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC,IAAI,EAAE;KACjD,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oCAAoC,GAAG,CAClD,UAAU,EACV,gBAAgB,EAChB,EAAE;IACF,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,wBAAwB,CAAC,gBAAgB,CAAC,CAAC;IAExE,MAAM,IAAI,GAAG,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,KAAI,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAE7D,IAAI,IAAI,IAAI,IAAI,EAAE;QAChB,OAAO,EAAE,CAAC;KACX;IAED,IAAI,SAAS,CAAC;IACd,IAAI,MAAM,EAAE;QACV,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;KACxC;SAAM;QACL,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/C,SAAS,GAAG,IAAI,CAAC,iBAAiB,CAAC,CAAC;KACrC;IAED,OAAO;QACL,SAAS;QACT,MAAM;QACN,QAAQ;KACT,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,UAAU,EAAE,gBAAgB,EAAE,EAAE;IAC5E,IAAI,UAAU,IAAI,IAAI,IAAI,CAAC,gBAAgB,IAAI,gBAAgB,IAAI,IAAI,EAAE;QACvE,OAAO,EAAE,CAAC;KACX;IAED,MAAM,EAAE,SAAS,EAAE,GAAG,oCAAoC,CACxD,UAAU,EACV,gBAAgB,CACjB,CAAC;IAEF,IAAI,SAAS,IAAI,IAAI,EAAE;QACrB,OAAO,EAAE,CAAC;KACX;IAED,OAAO;QACL,KAAK,EAAE,SAAS,CAAC,OAAO;QACxB,WAAW,EAAE,SAAS,CAAC,WAAW;KACnC,CAAC;AACJ,CAAC,CAAC"}
|
package/bin/dev/index.js
ADDED
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
import { existsSync } from "fs";
|
|
2
|
+
import { promises as _promises } from "fs";
|
|
3
|
+
import fse from "fs-extra";
|
|
4
|
+
import { isInternetAvailable } from "is-internet-available";
|
|
5
|
+
import path from "path";
|
|
6
|
+
import shell from "shelljs";
|
|
7
|
+
import SwaggerParser from "@apidevtools/swagger-parser";
|
|
8
|
+
import { createPage, injectNav } from "./injectNav.js";
|
|
9
|
+
import { CMD_EXEC_PATH, CLIENT_PATH, INSTALL_PATH } from "../constants.js";
|
|
10
|
+
const { readdir, readFile } = _promises;
|
|
11
|
+
const getFileList = async (dirName, og = dirName) => {
|
|
12
|
+
let files = [];
|
|
13
|
+
const items = await readdir(dirName, { withFileTypes: true });
|
|
14
|
+
for (const item of items) {
|
|
15
|
+
if (item.isDirectory()) {
|
|
16
|
+
files = [...files, ...(await getFileList(`${dirName}/${item.name}`, og))];
|
|
17
|
+
}
|
|
18
|
+
else {
|
|
19
|
+
const path = `${dirName}/${item.name}`;
|
|
20
|
+
const name = path.replace(og, "");
|
|
21
|
+
files.push({ path, isSymbolicLink: item.isSymbolicLink(), name });
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
return files;
|
|
25
|
+
};
|
|
26
|
+
const copyFiles = async () => {
|
|
27
|
+
shell.cd(CMD_EXEC_PATH);
|
|
28
|
+
const markdownFiles = [];
|
|
29
|
+
const staticFiles = [];
|
|
30
|
+
const allFilesInDocsFolder = await getFileList(CMD_EXEC_PATH);
|
|
31
|
+
const promises = [];
|
|
32
|
+
let openApi = undefined;
|
|
33
|
+
allFilesInDocsFolder.forEach((file) => {
|
|
34
|
+
promises.push((async () => {
|
|
35
|
+
const extension = file.name.substring(file.name.lastIndexOf(".") + 1, file.name.length) || file.name;
|
|
36
|
+
if (extension &&
|
|
37
|
+
(extension === "mdx" || extension === "md" || extension === "tsx")) {
|
|
38
|
+
markdownFiles.push(file.name);
|
|
39
|
+
}
|
|
40
|
+
else if (extension &&
|
|
41
|
+
(extension === "json" || extension === "yaml" || extension === "yml")) {
|
|
42
|
+
try {
|
|
43
|
+
const fileContent = await readFile(file.path);
|
|
44
|
+
fse.outputFileSync("openapi", fileContent.toString("utf-8"));
|
|
45
|
+
const api = await SwaggerParser.validate("openapi");
|
|
46
|
+
openApi = Buffer.from(JSON.stringify(api, null, 2), "utf-8");
|
|
47
|
+
}
|
|
48
|
+
catch (_a) {
|
|
49
|
+
// not valid openApi
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
if (!file.name.endsWith("mint.config.json") ||
|
|
53
|
+
!file.name.endsWith("mint.json")) {
|
|
54
|
+
// all other files
|
|
55
|
+
staticFiles.push(file.name);
|
|
56
|
+
}
|
|
57
|
+
})());
|
|
58
|
+
});
|
|
59
|
+
await Promise.all(promises);
|
|
60
|
+
fse.removeSync("openapi");
|
|
61
|
+
const configTargetPath = path.join(CLIENT_PATH, "src", "mint.json");
|
|
62
|
+
fse.removeSync(configTargetPath);
|
|
63
|
+
let configObj = null;
|
|
64
|
+
let configPath = null;
|
|
65
|
+
if (existsSync(path.join(CMD_EXEC_PATH, "mint.config.json"))) {
|
|
66
|
+
configPath = path.join(CMD_EXEC_PATH, "mint.config.json");
|
|
67
|
+
}
|
|
68
|
+
if (existsSync(path.join(CMD_EXEC_PATH, "mint.json"))) {
|
|
69
|
+
configPath = path.join(CMD_EXEC_PATH, "mint.json");
|
|
70
|
+
}
|
|
71
|
+
while (configPath && !existsSync(configTargetPath)) {
|
|
72
|
+
await fse.remove(configTargetPath);
|
|
73
|
+
await fse.copy(configPath, configTargetPath);
|
|
74
|
+
}
|
|
75
|
+
const configContents = await readFile(configPath);
|
|
76
|
+
configObj = JSON.parse(configContents.toString());
|
|
77
|
+
const openApiTargetPath = path.join(CLIENT_PATH, "src", "openapi.json");
|
|
78
|
+
let openApiObj = null;
|
|
79
|
+
if (openApi) {
|
|
80
|
+
await fse.outputFile(openApiTargetPath, Buffer.from(openApi), {
|
|
81
|
+
flag: "w",
|
|
82
|
+
});
|
|
83
|
+
openApiObj = JSON.parse(openApi.toString());
|
|
84
|
+
}
|
|
85
|
+
else {
|
|
86
|
+
fse.outputFileSync(openApiTargetPath, "{}", { flag: "w" });
|
|
87
|
+
}
|
|
88
|
+
let pages = {};
|
|
89
|
+
const mdPromises = [];
|
|
90
|
+
markdownFiles.forEach(async (filename) => {
|
|
91
|
+
mdPromises.push((async () => {
|
|
92
|
+
const sourcePath = path.join(CMD_EXEC_PATH, filename);
|
|
93
|
+
const pagesDir = path.join(CLIENT_PATH, "src", "pages");
|
|
94
|
+
const targetPath = path.join(pagesDir, filename);
|
|
95
|
+
await fse.remove(targetPath);
|
|
96
|
+
await fse.copy(sourcePath, targetPath);
|
|
97
|
+
const fileContent = await readFile(sourcePath);
|
|
98
|
+
const contentStr = fileContent.toString();
|
|
99
|
+
const page = createPage(filename, contentStr, openApiObj);
|
|
100
|
+
pages = Object.assign(Object.assign({}, pages), page);
|
|
101
|
+
})());
|
|
102
|
+
});
|
|
103
|
+
await Promise.all(mdPromises);
|
|
104
|
+
injectNav(pages, configObj);
|
|
105
|
+
staticFiles.forEach(async (filename) => {
|
|
106
|
+
const sourcePath = path.join(CMD_EXEC_PATH, filename);
|
|
107
|
+
const publicDir = path.join(CLIENT_PATH, "public");
|
|
108
|
+
const targetPath = path.join(publicDir, filename);
|
|
109
|
+
await fse.remove(targetPath);
|
|
110
|
+
await fse.copy(sourcePath, targetPath);
|
|
111
|
+
});
|
|
112
|
+
};
|
|
113
|
+
const gitExists = () => {
|
|
114
|
+
let doesGitExist = true;
|
|
115
|
+
try {
|
|
116
|
+
shell.exec("git --version", { silent: true });
|
|
117
|
+
}
|
|
118
|
+
catch (e) {
|
|
119
|
+
doesGitExist = false;
|
|
120
|
+
}
|
|
121
|
+
return doesGitExist;
|
|
122
|
+
};
|
|
123
|
+
const dev = async () => {
|
|
124
|
+
shell.cd(INSTALL_PATH);
|
|
125
|
+
// TODO error messages
|
|
126
|
+
if (!existsSync(path.join(INSTALL_PATH, "mint"))) {
|
|
127
|
+
shell.exec("mkdir mint");
|
|
128
|
+
}
|
|
129
|
+
shell.cd("mint");
|
|
130
|
+
let runYarn = true;
|
|
131
|
+
const gitInstalled = gitExists();
|
|
132
|
+
if (!existsSync(path.join(INSTALL_PATH, "mint", ".git")) && gitInstalled) {
|
|
133
|
+
shell.exec("git init", { silent: true });
|
|
134
|
+
shell.exec("git remote add -f mint-origin https://github.com/mintlify/mint.git", { silent: true });
|
|
135
|
+
}
|
|
136
|
+
const internet = await isInternetAvailable();
|
|
137
|
+
let pullOutput = null;
|
|
138
|
+
if (internet && gitInstalled) {
|
|
139
|
+
shell.exec("git config core.sparseCheckout true", { silent: true });
|
|
140
|
+
shell.exec('echo "client/" >> .git/info/sparse-checkout', { silent: true });
|
|
141
|
+
pullOutput = shell.exec("git pull mint-origin main", {
|
|
142
|
+
silent: true,
|
|
143
|
+
}).stdout;
|
|
144
|
+
shell.exec("git config core.sparseCheckout false", { silent: true });
|
|
145
|
+
shell.exec("rm .git/info/sparse-checkout", { silent: true });
|
|
146
|
+
}
|
|
147
|
+
if (pullOutput === "Already up to date.\n") {
|
|
148
|
+
runYarn = false;
|
|
149
|
+
}
|
|
150
|
+
shell.cd(CLIENT_PATH);
|
|
151
|
+
if (runYarn) {
|
|
152
|
+
shell.exec("yarn", { silent: true });
|
|
153
|
+
}
|
|
154
|
+
// TODO check for mint.json before copying over files
|
|
155
|
+
await copyFiles();
|
|
156
|
+
run();
|
|
157
|
+
};
|
|
158
|
+
const run = () => {
|
|
159
|
+
shell.cd(CLIENT_PATH);
|
|
160
|
+
shell.exec("npm run dev");
|
|
161
|
+
open("https://localhost:3000");
|
|
162
|
+
};
|
|
163
|
+
export default dev;
|
|
164
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/dev/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAChC,OAAO,EAAE,QAAQ,IAAI,SAAS,EAAE,MAAM,IAAI,CAAC;AAC3C,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,aAAa,MAAM,6BAA6B,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE3E,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC;AAExC,MAAM,WAAW,GAAG,KAAK,EAAE,OAAe,EAAE,EAAE,GAAG,OAAO,EAAE,EAAE;IAC1D,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAE9D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;QACxB,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE;YACtB,KAAK,GAAG,CAAC,GAAG,KAAK,EAAE,GAAG,CAAC,MAAM,WAAW,CAAC,GAAG,OAAO,IAAI,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;SAC3E;aAAM;YACL,MAAM,IAAI,GAAG,GAAG,OAAO,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACvC,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;YAClC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;SACnE;KACF;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,KAAK,IAAI,EAAE;IAC3B,KAAK,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC;IACxB,MAAM,aAAa,GAAG,EAAE,CAAC;IACzB,MAAM,WAAW,GAAG,EAAE,CAAC;IACvB,MAAM,oBAAoB,GAAG,MAAM,WAAW,CAAC,aAAa,CAAC,CAAC;IAC9D,MAAM,QAAQ,GAAG,EAAE,CAAC;IACpB,IAAI,OAAO,GAAG,SAAS,CAAC;IACxB,oBAAoB,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACpC,QAAQ,CAAC,IAAI,CACX,CAAC,KAAK,IAAI,EAAE;YACV,MAAM,SAAS,GACb,IAAI,CAAC,IAAI,CAAC,SAAS,CACjB,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAC9B,IAAI,CAAC,IAAI,CAAC,MAAM,CACjB,IAAI,IAAI,CAAC,IAAI,CAAC;YACjB,IACE,SAAS;gBACT,CAAC,SAAS,KAAK,KAAK,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,KAAK,CAAC,EAClE;gBACA,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC/B;iBAAM,IACL,SAAS;gBACT,CAAC,SAAS,KAAK,MAAM,IAAI,SAAS,KAAK,MAAM,IAAI,SAAS,KAAK,KAAK,CAAC,EACrE;gBACA,IAAI;oBACF,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBAC9C,GAAG,CAAC,cAAc,CAAC,SAAS,EAAE,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;oBAC7D,MAAM,GAAG,GAAG,MAAM,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;oBACpD,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;iBAC9D;gBAAC,WAAM;oBACN,oBAAoB;iBACrB;aACF;YACD,IACE,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC;gBACvC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAChC;gBACA,kBAAkB;gBAClB,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC7B;QACH,CAAC,CAAC,EAAE,CACL,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5B,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IAE1B,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;IACpE,GAAG,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;IACjC,IAAI,SAAS,GAAG,IAAI,CAAC;IACrB,IAAI,UAAU,GAAG,IAAI,CAAC;IACtB,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC,EAAE;QAC5D,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC;KAC3D;IAED,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC,EAAE;QACrD,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;KACpD;IAED,OAAO,UAAU,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE;QAClD,MAAM,GAAG,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACnC,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;KAC9C;IACD,MAAM,cAAc,GAAG,MAAM,QAAQ,CAAC,UAAU,CAAC,CAAC;IAClD,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC;IAElD,MAAM,iBAAiB,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;IACxE,IAAI,UAAU,GAAG,IAAI,CAAC;IACtB,IAAI,OAAO,EAAE;QACX,MAAM,GAAG,CAAC,UAAU,CAAC,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YAC5D,IAAI,EAAE,GAAG;SACV,CAAC,CAAC;QACH,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;KAC7C;SAAM;QACL,GAAG,CAAC,cAAc,CAAC,iBAAiB,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;KAC5D;IACD,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,MAAM,UAAU,GAAG,EAAE,CAAC;IACtB,aAAa,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;QACvC,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,UAAU,CAAC,CAAC;YAC1D,KAAK,mCACA,KAAK,GACL,IAAI,CACR,CAAC;QACJ,CAAC,CAAC,EAAE,CACL,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,MAAM,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC9B,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAE5B,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;QACrC,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;QACtD,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QACnD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAElD,MAAM,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAC7B,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AACF,MAAM,SAAS,GAAG,GAAG,EAAE;IACrB,IAAI,YAAY,GAAG,IAAI,CAAC;IACxB,IAAI;QACF,KAAK,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;KAC/C;IAAC,OAAO,CAAC,EAAE;QACV,YAAY,GAAG,KAAK,CAAC;KACtB;IACD,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC;AAEF,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE;IACrB,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC;IACvB,sBAAsB;IACtB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,EAAE;QAChD,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;KAC1B;IACD,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IACjB,IAAI,OAAO,GAAG,IAAI,CAAC;IACnB,MAAM,YAAY,GAAG,SAAS,EAAE,CAAC;IACjC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,IAAI,YAAY,EAAE;QACxE,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACzC,KAAK,CAAC,IAAI,CACR,oEAAoE,EACpE,EAAE,MAAM,EAAE,IAAI,EAAE,CACjB,CAAC;KACH;IAED,MAAM,QAAQ,GAAG,MAAM,mBAAmB,EAAE,CAAC;IAC7C,IAAI,UAAU,GAAG,IAAI,CAAC;IACtB,IAAI,QAAQ,IAAI,YAAY,EAAE;QAC5B,KAAK,CAAC,IAAI,CAAC,qCAAqC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACpE,KAAK,CAAC,IAAI,CAAC,6CAA6C,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5E,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,2BAA2B,EAAE;YACnD,MAAM,EAAE,IAAI;SACb,CAAC,CAAC,MAAM,CAAC;QACV,KAAK,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACrE,KAAK,CAAC,IAAI,CAAC,8BAA8B,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;KAC9D;IACD,IAAI,UAAU,KAAK,uBAAuB,EAAE;QAC1C,OAAO,GAAG,KAAK,CAAC;KACjB;IACD,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IACtB,IAAI,OAAO,EAAE;QACX,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;KACtC;IACD,qDAAqD;IACrD,MAAM,SAAS,EAAE,CAAC;IAClB,GAAG,EAAE,CAAC;AACR,CAAC,CAAC;AAEF,MAAM,GAAG,GAAG,GAAG,EAAE;IACf,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IACtB,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC1B,IAAI,CAAC,wBAAwB,CAAC,CAAC;AACjC,CAAC,CAAC;AAEF,eAAe,GAAG,CAAC"}
|
|
@@ -0,0 +1,97 @@
|
|
|
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
|
+
console.log({ targetPath });
|
|
91
|
+
console.log({ newNavFile });
|
|
92
|
+
fs.outputFileSync(targetPath, JSON.stringify(newNavFile, null, 2), {
|
|
93
|
+
flag: "w",
|
|
94
|
+
});
|
|
95
|
+
console.log(`⛵️ Navigation generated and injected`);
|
|
96
|
+
};
|
|
97
|
+
//# sourceMappingURL=injectNav.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"injectNav.js","sourceRoot":"","sources":["../../src/dev/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,OAAO,CAAC,GAAG,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;IAC5B,OAAO,CAAC,GAAG,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;IAC5B,EAAE,CAAC,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE;QACjE,IAAI,EAAE,GAAG;KACV,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;AACtD,CAAC,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export const slugToTitle = (slug) => {
|
|
2
|
+
const slugArr = slug.split("/");
|
|
3
|
+
let defaultTitle = slugArr[slugArr.length - 1].split("-").join(" "); //replace all dashes
|
|
4
|
+
defaultTitle = defaultTitle.split("_").join(" "); //replace all underscores
|
|
5
|
+
defaultTitle = defaultTitle.charAt(0).toUpperCase() + defaultTitle.slice(1); //capitalize first letter
|
|
6
|
+
return defaultTitle;
|
|
7
|
+
};
|
|
8
|
+
//# sourceMappingURL=slugToTitle.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"slugToTitle.js","sourceRoot":"","sources":["../../src/dev/slugToTitle.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE,EAAE;IAClC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAChC,IAAI,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,oBAAoB;IACzF,YAAY,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,yBAAyB;IAC3E,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,yBAAyB;IACtG,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { existsSync, mkdirSync, createWriteStream } from "fs";
|
|
2
|
+
import path from "path";
|
|
3
|
+
import axios from "axios";
|
|
4
|
+
export default async function downloadImage(imageSrc, writePath) {
|
|
5
|
+
// Avoid unnecessary downloads
|
|
6
|
+
if (existsSync(writePath)) {
|
|
7
|
+
return Promise.reject({
|
|
8
|
+
code: "EEXIST",
|
|
9
|
+
});
|
|
10
|
+
}
|
|
11
|
+
// Create the folders needed if they're missing
|
|
12
|
+
mkdirSync(path.dirname(writePath), { recursive: true });
|
|
13
|
+
const writer = createWriteStream(writePath);
|
|
14
|
+
const response = await axios.default.get(imageSrc, {
|
|
15
|
+
responseType: "stream",
|
|
16
|
+
});
|
|
17
|
+
// wx prevents overwriting an image with the exact same name
|
|
18
|
+
// being created in the time we were downloading
|
|
19
|
+
response.data.pipe(writer, {
|
|
20
|
+
flag: "wx",
|
|
21
|
+
});
|
|
22
|
+
return new Promise((resolve, reject) => {
|
|
23
|
+
writer.on("finish", resolve);
|
|
24
|
+
writer.on("error", reject);
|
|
25
|
+
});
|
|
26
|
+
}
|
|
27
|
+
//# sourceMappingURL=downloadImage.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"downloadImage.js","sourceRoot":"","sources":["../src/downloadImage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,IAAI,CAAC;AAC9D,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,CAAC,OAAO,CAAC,KAAK,UAAU,aAAa,CACzC,QAAgB,EAChB,SAAiB;IAEjB,8BAA8B;IAC9B,IAAI,UAAU,CAAC,SAAS,CAAC,EAAE;QACzB,OAAO,OAAO,CAAC,MAAM,CAAC;YACpB,IAAI,EAAE,QAAQ;SACf,CAAC,CAAC;KACJ;IAED,+CAA+C;IAC/C,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAExD,MAAM,MAAM,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAE5C,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE;QACjD,YAAY,EAAE,QAAQ;KACvB,CAAC,CAAC;IAEH,4DAA4D;IAC5D,gDAAgD;IAChD,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;QACzB,IAAI,EAAE,IAAI;KACX,CAAC,CAAC;IAEH,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC7B,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;AACL,CAAC"}
|
package/bin/index.js
CHANGED
|
@@ -1,107 +1,50 @@
|
|
|
1
|
-
|
|
2
|
-
import
|
|
3
|
-
import
|
|
4
|
-
import
|
|
5
|
-
import
|
|
6
|
-
import {
|
|
7
|
-
import {
|
|
8
|
-
import {
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
writeFileSync("mint.config.json", JSON.stringify(MintConfig(name, color, ctaName, ctaUrl, toFilename(title)), null, "\t"));
|
|
51
|
-
createPage(title);
|
|
52
|
-
console.log("🌱 Created initial files for Mintlify docs");
|
|
53
|
-
process.exit(1);
|
|
54
|
-
})
|
|
55
|
-
.catch((error) => {
|
|
56
|
-
console.error(error);
|
|
57
|
-
process.exit(1);
|
|
58
|
-
});
|
|
59
|
-
}
|
|
60
|
-
if (command === "page") {
|
|
61
|
-
inquirer
|
|
62
|
-
.prompt([
|
|
63
|
-
{
|
|
64
|
-
type: "input",
|
|
65
|
-
name: "title",
|
|
66
|
-
message: "What is the title of the new page?",
|
|
67
|
-
},
|
|
68
|
-
{
|
|
69
|
-
type: "input",
|
|
70
|
-
name: "description",
|
|
71
|
-
message: "What is the description?",
|
|
72
|
-
default: "",
|
|
73
|
-
},
|
|
74
|
-
])
|
|
75
|
-
.then((answers) => {
|
|
76
|
-
const { title, description } = answers;
|
|
77
|
-
createPage(title, description);
|
|
78
|
-
console.log("🌱 Created initial files for Mintlify docs");
|
|
79
|
-
process.exit(1);
|
|
80
|
-
})
|
|
81
|
-
.catch((error) => {
|
|
82
|
-
console.error(error);
|
|
83
|
-
process.exit(1);
|
|
84
|
-
});
|
|
85
|
-
}
|
|
86
|
-
if (command === "scrape-gitbook-page") {
|
|
87
|
-
const url = args[1];
|
|
88
|
-
const { title, description, markdown } = await scrapeGitBookPage(url);
|
|
89
|
-
createPage(title, description, markdown, process.cwd());
|
|
90
|
-
process.exit(1);
|
|
91
|
-
}
|
|
92
|
-
if (command === "scrape-readme-page") {
|
|
93
|
-
const url = args[1];
|
|
94
|
-
const { title, description, markdown } = await scrapeReadMePage(url);
|
|
95
|
-
createPage(title, description, markdown, process.cwd());
|
|
96
|
-
process.exit(1);
|
|
97
|
-
}
|
|
98
|
-
if (command === "scrape-readme-section") {
|
|
99
|
-
const url = args[1];
|
|
100
|
-
console.log("Started scraping...");
|
|
101
|
-
const groupsConfig = await scrapeReadMe(url, process.cwd());
|
|
102
|
-
console.log("Finished scraping.");
|
|
103
|
-
console.log("Add the following to your navigation in mint.config.js:");
|
|
104
|
-
console.log(objToReadableString(groupsConfig));
|
|
105
|
-
process.exit(1);
|
|
106
|
-
}
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import yargs from "yargs";
|
|
3
|
+
import { hideBin } from "yargs/helpers";
|
|
4
|
+
import initCommand from "./init-command/index.js";
|
|
5
|
+
import generatePageTemplate from "./pageTemplate.js";
|
|
6
|
+
import { scrapePageAutomatically, scrapePageWrapper, } from "./scraping/scrapePageCommands.js";
|
|
7
|
+
import { scrapeDocusaurusPage } from "./scraping/site-scrapers/scrapeDocusaurusPage.js";
|
|
8
|
+
import { scrapeGitBookPage } from "./scraping/site-scrapers/scrapeGitBookPage.js";
|
|
9
|
+
import { scrapeReadMePage } from "./scraping/site-scrapers/scrapeReadMePage.js";
|
|
10
|
+
import { scrapeSectionAutomatically, scrapeSectionAxiosWrapper, scrapeGitbookSectionCommand, } from "./scraping/scrapeSectionCommands.js";
|
|
11
|
+
import { scrapeDocusaurusSection } from "./scraping/site-scrapers/scrapeDocusaurusSection.js";
|
|
12
|
+
import { scrapeReadMeSection } from "./scraping/site-scrapers/scrapeReadMeSection.js";
|
|
13
|
+
import dev from "./local-preview/index.js";
|
|
14
|
+
// TODO - add descriptions to the command options https://github.com/yargs/yargs/blob/HEAD/docs/api.md#commandmodule
|
|
15
|
+
yargs(hideBin(process.argv))
|
|
16
|
+
.command("dev", "Runs Mintlify locally (Must run in directory with mint.json)", () => { }, async () => {
|
|
17
|
+
await dev();
|
|
18
|
+
})
|
|
19
|
+
.command("init", "Generate a mintlify template", () => { }, () => {
|
|
20
|
+
initCommand();
|
|
21
|
+
})
|
|
22
|
+
.command("page", "Generate a new page", () => { }, () => {
|
|
23
|
+
generatePageTemplate();
|
|
24
|
+
})
|
|
25
|
+
.command("scrape-page [url]", "Scrapes a page", () => { }, async (argv) => {
|
|
26
|
+
await scrapePageAutomatically(argv);
|
|
27
|
+
})
|
|
28
|
+
.command("scrape-docusaurus-page [url]", "Scrapes a Docusaurus page", () => { }, async (argv) => {
|
|
29
|
+
await scrapePageWrapper(argv, scrapeDocusaurusPage);
|
|
30
|
+
})
|
|
31
|
+
.command("scrape-gitbook-page [url]", "Scrapes a GitBook page", () => { }, async (argv) => {
|
|
32
|
+
await scrapePageWrapper(argv, scrapeGitBookPage);
|
|
33
|
+
})
|
|
34
|
+
.command("scrape-readme-page [url]", "Scrapes a ReadMe page", () => { }, async (argv) => {
|
|
35
|
+
await scrapePageWrapper(argv, scrapeReadMePage);
|
|
36
|
+
})
|
|
37
|
+
.command("scrape-section [url]", "Scrapes the docs in the section", () => { }, async (argv) => {
|
|
38
|
+
await scrapeSectionAutomatically(argv);
|
|
39
|
+
})
|
|
40
|
+
.command("scrape-docusaurus-section [url]", "Scrapes the Docusaurus section", () => { }, async (argv) => {
|
|
41
|
+
await scrapeSectionAxiosWrapper(argv, scrapeDocusaurusSection);
|
|
42
|
+
})
|
|
43
|
+
.command("scrape-gitbook-section [url]", "Scrapes the Gitbook section", () => { }, async (argv) => {
|
|
44
|
+
await scrapeGitbookSectionCommand(argv);
|
|
45
|
+
})
|
|
46
|
+
.command("scrape-readme-section [url]", "Scrapes the ReadMe section", () => { }, async (argv) => {
|
|
47
|
+
await scrapeSectionAxiosWrapper(argv, scrapeReadMeSection);
|
|
48
|
+
})
|
|
49
|
+
.parse();
|
|
107
50
|
//# sourceMappingURL=index.js.map
|
package/bin/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,
|
|
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,oBAAoB,EAAE,MAAM,kDAAkD,CAAC;AACxF,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,uBAAuB,EAAE,MAAM,qDAAqD,CAAC;AAC9F,OAAO,EAAE,mBAAmB,EAAE,MAAM,iDAAiD,CAAC;AACtF,OAAO,GAAG,MAAM,0BAA0B,CAAC;AAE3C,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,MAAM,EACN,8BAA8B,EAC9B,GAAG,EAAE,GAAE,CAAC,EACR,GAAG,EAAE;IACH,WAAW,EAAE,CAAC;AAChB,CAAC,CACF;KACA,OAAO,CACN,MAAM,EACN,qBAAqB,EACrB,GAAG,EAAE,GAAE,CAAC,EACR,GAAG,EAAE;IACH,oBAAoB,EAAE,CAAC;AACzB,CAAC,CACF;KACA,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,8BAA8B,EAC9B,2BAA2B,EAC3B,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,iBAAiB,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC;AACtD,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,iCAAiC,EACjC,gCAAgC,EAChC,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,yBAAyB,CAAC,IAAI,EAAE,uBAAuB,CAAC,CAAC;AACjE,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"}
|