From 5cda6b24a71edb15ff86e8ee7865e98e54546066 Mon Sep 17 00:00:00 2001 From: Gregor Adams <1148334+pixelass@users.noreply.github.com> Date: Mon, 6 May 2024 21:48:30 +0200 Subject: [PATCH] chore: integrate docs for the SDK packages (#267) ## Motivation - integrates the docs for our SDK by reading them from node_modules - adds create-captain-app for that purpose - updates to the latest packages - renames the header links in the docs to "Core API" and adds "SDK" ## Issues closed --- .gitignore | 5 + .../create-captain-app/_meta.json | 3 + homepage/pages/_captain-sdk/joy/_meta.json | 3 + homepage/pages/_captain-sdk/react/_meta.json | 3 + homepage/pages/_captain-sdk/theme/_meta.json | 3 + homepage/pages/_captain-sdk/utils/_meta.json | 3 + homepage/pages/_meta.json | 6 +- homepage/pages/captain-sdk/_meta.json | 8 + homepage/pages/captain-sdk/index.mdx | 38 +++++ package-lock.json | 158 +++++++++++++++--- package.json | 18 +- scripts/nextra-meta.mjs | 18 +- tsconfig.captn.json | 27 +++ typedoc.captn-joy.json | 24 +++ typedoc.captn-react.json | 24 +++ typedoc.captn-theme.json | 24 +++ typedoc.captn-utils.json | 24 +++ typedoc.create-captain-app.json | 24 +++ 18 files changed, 376 insertions(+), 37 deletions(-) create mode 100644 homepage/pages/_captain-sdk/create-captain-app/_meta.json create mode 100644 homepage/pages/_captain-sdk/joy/_meta.json create mode 100644 homepage/pages/_captain-sdk/react/_meta.json create mode 100644 homepage/pages/_captain-sdk/theme/_meta.json create mode 100644 homepage/pages/_captain-sdk/utils/_meta.json create mode 100644 homepage/pages/captain-sdk/_meta.json create mode 100644 homepage/pages/captain-sdk/index.mdx create mode 100644 tsconfig.captn.json create mode 100644 typedoc.captn-joy.json create mode 100644 typedoc.captn-react.json create mode 100644 typedoc.captn-theme.json create mode 100644 typedoc.captn-utils.json create mode 100644 typedoc.create-captain-app.json diff --git a/.gitignore b/.gitignore index af995ba3f..5833c9c52 100644 --- a/.gitignore +++ b/.gitignore @@ -32,3 +32,8 @@ homepage/pages/captain-core/client/ions homepage/pages/captain-core/client/organisms homepage/pages/captain-core/electron homepage/pages/captain-core/shared +homepage/pages/captain-sdk/create-captain-app +homepage/pages/captain-sdk/joy +homepage/pages/captain-sdk/react +homepage/pages/captain-sdk/theme +homepage/pages/captain-sdk/utils diff --git a/homepage/pages/_captain-sdk/create-captain-app/_meta.json b/homepage/pages/_captain-sdk/create-captain-app/_meta.json new file mode 100644 index 000000000..43f8f7a8c --- /dev/null +++ b/homepage/pages/_captain-sdk/create-captain-app/_meta.json @@ -0,0 +1,3 @@ +{ + "README": "Overview" +} diff --git a/homepage/pages/_captain-sdk/joy/_meta.json b/homepage/pages/_captain-sdk/joy/_meta.json new file mode 100644 index 000000000..43f8f7a8c --- /dev/null +++ b/homepage/pages/_captain-sdk/joy/_meta.json @@ -0,0 +1,3 @@ +{ + "README": "Overview" +} diff --git a/homepage/pages/_captain-sdk/react/_meta.json b/homepage/pages/_captain-sdk/react/_meta.json new file mode 100644 index 000000000..43f8f7a8c --- /dev/null +++ b/homepage/pages/_captain-sdk/react/_meta.json @@ -0,0 +1,3 @@ +{ + "README": "Overview" +} diff --git a/homepage/pages/_captain-sdk/theme/_meta.json b/homepage/pages/_captain-sdk/theme/_meta.json new file mode 100644 index 000000000..43f8f7a8c --- /dev/null +++ b/homepage/pages/_captain-sdk/theme/_meta.json @@ -0,0 +1,3 @@ +{ + "README": "Overview" +} diff --git a/homepage/pages/_captain-sdk/utils/_meta.json b/homepage/pages/_captain-sdk/utils/_meta.json new file mode 100644 index 000000000..43f8f7a8c --- /dev/null +++ b/homepage/pages/_captain-sdk/utils/_meta.json @@ -0,0 +1,3 @@ +{ + "README": "Overview" +} diff --git a/homepage/pages/_meta.json b/homepage/pages/_meta.json index 694c5f866..1820d8995 100644 --- a/homepage/pages/_meta.json +++ b/homepage/pages/_meta.json @@ -11,7 +11,11 @@ } }, "captain-core": { - "title": "Captain Core", + "title": "Core API", + "type": "page" + }, + "captain-sdk": { + "title": "SDK", "type": "page" }, "marketplace": { diff --git a/homepage/pages/captain-sdk/_meta.json b/homepage/pages/captain-sdk/_meta.json new file mode 100644 index 000000000..607f79847 --- /dev/null +++ b/homepage/pages/captain-sdk/_meta.json @@ -0,0 +1,8 @@ +{ + "index": "Overview", + "create-captain-app": "Create Captain App", + "utils": "@captn/utils", + "theme": "@captn/theme", + "react": "@captn/react", + "joy": "@captn/joy" +} diff --git a/homepage/pages/captain-sdk/index.mdx b/homepage/pages/captain-sdk/index.mdx new file mode 100644 index 000000000..0e8325330 --- /dev/null +++ b/homepage/pages/captain-sdk/index.mdx @@ -0,0 +1,38 @@ +# Captain SDK Documentation Overview + +Welcome to the comprehensive SDK documentation for the Captain framework. Here you'll find all the resources needed to effectively use and extend the capabilities of Captain through our carefully designed SDKs. Each SDK package is tailored to meet the diverse needs of developers, empowering you to build robust, scalable, and customizable applications with ease. + +## Overview of SDK Packages + +Our SDK is divided into several key packages, each serving a specific role within the Captain ecosystem: + +- **`create-captain-app`**: Streamlines the creation of new Captain projects with customizable templates, supporting a range of web technologies. +- **`@captn/joy`**: Provides UI components and utilities built on MUI Joy, enhancing the look and feel of your applications. +- **`@captn/react`**: Offers a collection of React hooks tailored to integrate seamlessly with the Captain framework for efficient app development. +- **`@captn/theme`**: Manages theming across Captain applications, ensuring consistent and appealing visual styles. +- **`@captn/utils`**: Supplies essential utilities and helper functions that support the broader functionality of the Captain applications. + +## Quick Start Guide + +For developers new to Captain, each SDK package can be quickly integrated into your projects. Installation instructions, basic usage examples, and further details are provided within the individual package documentation linked below: + +- [Create Captain App Documentation](/captain-sdk/create-captain-app/README) +- [@captn/joy Documentation](/captain-sdk/joy/README) +- [@captn/react Documentation](/captain-sdk/react/README) +- [@captn/theme Documentation](/captain-sdk/theme/README) +- [@captn/utils Documentation](/captain-sdk/utils/README) + +## Community and Collaboration + +We're proud of our vibrant community and encourage collaboration and feedback. Engage with other developers, contribute to the SDK, and help us enhance the Captain experience: + +- **Discord**: [Join our community on Discord](https://discord.com/invite/m3TBB9XEkb) to share, learn, and collaborate. +- **GitHub**: Visit our [GitHub repositories](https://github.com/blib-la/captn) to access the source code, report issues, or contribute. + +## Additional Resources + +For updates and enhancements, keep an eye on our [Changelog](https://github.com/blib-la/captn/blob/main/CHANGELOG.md) and explore additional resources to maximize your use of Captain. + +## Acknowledgments + +A heartfelt thanks to all our contributors and supporters who bring their passion and ideas to make the Captain framework what it is today. diff --git a/package-lock.json b/package-lock.json index 16d5f715f..3d682daf8 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "captain", - "version": "1.0.0-alpha.63", + "version": "1.0.0-alpha.64", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "captain", - "version": "1.0.0-alpha.63", + "version": "1.0.0-alpha.64", "hasInstallScript": true, "license": "AGPL 3.0", "dependencies": { @@ -19,10 +19,10 @@ "sharp": "0.33.2" }, "devDependencies": { - "@captn/joy": "^0.24.0", - "@captn/react": "^0.24.0", - "@captn/theme": "^0.24.0", - "@captn/utils": "^0.24.0", + "@captn/joy": "^0.26.2", + "@captn/react": "^0.26.2", + "@captn/theme": "^0.26.2", + "@captn/utils": "^0.26.2", "@commitlint/cli": "^19.3.0", "@commitlint/config-conventional": "^19.2.2", "@dnd-kit/core": "^6.1.0", @@ -70,6 +70,7 @@ "axios": "^1.6.8", "conventional-changelog-cli": "^4.1.0", "cpy-cli": "^5.0.0", + "create-captain-app": "^0.26.2", "cross-env": "^7.0.3", "dayjs": "1.11.11", "docusaurus-plugin-typedoc": "^0.22.0", @@ -2149,13 +2150,14 @@ "license": "MIT" }, "node_modules/@captn/joy": { - "version": "0.24.0", - "resolved": "https://registry.npmjs.org/@captn/joy/-/joy-0.24.0.tgz", - "integrity": "sha512-jgKaltJ25Gs8NrfQMwuGxl8/Dad6YM84xmXUg4gVkrE+gm+gdMzVpVcxIPd59I0xUwb/rrHNEfGHVzmJKUlt8g==", + "version": "0.26.2", + "resolved": "https://registry.npmjs.org/@captn/joy/-/joy-0.26.2.tgz", + "integrity": "sha512-UajLBErkPQXgrFqTDVw4HR96wlkgIFtc1YA184Gq60G6byhu2y57g3TNJcH//DOou41AIRZ7rnzPK3kw5bs4ww==", "dev": true, "dependencies": { - "@captn/theme": "^0.24.0", - "@captn/utils": "^0.24.0", + "@captn/react": "^0.26.2", + "@captn/theme": "^0.26.2", + "@captn/utils": "^0.26.2", "@mui/base": "5.0.0-beta.37", "@mui/icons-material": "5.15.11", "@mui/material": "5.15.11", @@ -2270,15 +2272,16 @@ } }, "node_modules/@captn/react": { - "version": "0.24.0", - "resolved": "https://registry.npmjs.org/@captn/react/-/react-0.24.0.tgz", - "integrity": "sha512-erLORd2MDjdcOmBSBexOVQAS9DqMqriKdBfqS+OPStuT35UufDKaNSqYZrWuGtOE/se6u439wTcYNMVJY2mo2Q==", + "version": "0.26.2", + "resolved": "https://registry.npmjs.org/@captn/react/-/react-0.26.2.tgz", + "integrity": "sha512-6mMvr5AUpD46T7dwLM5C/0e197exQcFwMNpQlGE7X5AK/3LjsZH3J/GxpMw454cM1V132FP+OOlkafCGfg4h0g==", "dev": true, "dependencies": { - "@captn/utils": "^0.24.0", + "@captn/utils": "^0.26.2", "dot-prop": "^8.0.2", "lodash.isequal": "^4.5.0", - "use-debounce": "^10.0.0" + "use-debounce": "^10.0.0", + "uuid": "^9.0.1" }, "peerDependencies": { "react": ">=18", @@ -2286,12 +2289,12 @@ } }, "node_modules/@captn/theme": { - "version": "0.24.0", - "resolved": "https://registry.npmjs.org/@captn/theme/-/theme-0.24.0.tgz", - "integrity": "sha512-njp6Ru/6Yx4wLK/rVWrlIESU/irDlGPo2F1JtI2qc4mi7Q45qpelwvo/GNFdZaqmBsd/5/MsjJ1kiyDxXa3tRQ==", + "version": "0.26.2", + "resolved": "https://registry.npmjs.org/@captn/theme/-/theme-0.26.2.tgz", + "integrity": "sha512-DiLU/4jj72TpWaKCniGdInbDjMjsSQIvXmXXqsRj0G+mOcRk/ziCrMYpvrzkJCstv61CqjP8Tw71x1LA/0Jmcw==", "dev": true, "dependencies": { - "@captn/utils": "^0.24.0" + "@captn/utils": "^0.26.2" }, "peerDependencies": { "@emotion/react": ">=11.11.3", @@ -2301,9 +2304,9 @@ } }, "node_modules/@captn/utils": { - "version": "0.24.0", - "resolved": "https://registry.npmjs.org/@captn/utils/-/utils-0.24.0.tgz", - "integrity": "sha512-aaQNEMGYHoMgnQb7wy8AiFY0GClCC3vttNoLCQ1ZcKUiD91HoJx2fWekp7oejbUBQPTVzufBfWH4BwTt/IMjIw==", + "version": "0.26.2", + "resolved": "https://registry.npmjs.org/@captn/utils/-/utils-0.26.2.tgz", + "integrity": "sha512-5nB2DRTf5q01tetcYQT6XT4/lRe3a2qlY9QtcWbT921N/V6X7Q2ROs6sKj3mpJCuR9mCop45n+G2wcAUs66ktA==", "dev": true, "dependencies": { "@qdrant/js-client-rest": "^1.8.1", @@ -10132,6 +10135,83 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/create-captain-app": { + "version": "0.26.2", + "resolved": "https://registry.npmjs.org/create-captain-app/-/create-captain-app-0.26.2.tgz", + "integrity": "sha512-QN2rLAbNe50tDrOpy7d1J5/GybNiTs2FeSMncBGJagh6dO5cRR5U0tMNcK8CUCgX+NaEZWsUPQjWtm+ZI33qnA==", + "dev": true, + "dependencies": { + "@captn/utils": "^0.26.2", + "axios": "^1.6.8", + "chalk": "^5.3.0", + "execa": "^8.0.1", + "globby": "^14.0.1", + "gray-matter": "^4.0.3", + "humanize-string": "^3.0.0", + "js-yaml": "^3.14.1", + "meow": "^13.2.0", + "tar": "^6.2.1", + "uuid": "^9.0.1" + }, + "bin": { + "create-captain-app": "dist/bin.js" + }, + "engines": { + "node": ">=20" + } + }, + "node_modules/create-captain-app/node_modules/argparse": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", + "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "dev": true, + "dependencies": { + "sprintf-js": "~1.0.2" + } + }, + "node_modules/create-captain-app/node_modules/chalk": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.3.0.tgz", + "integrity": "sha512-dLitG79d+GV1Nb/VYcCDFivJeK1hiukt9QjRNVOsUtTy1rR1YJsmpGGTZ3qJos+uw7WmWF4wUwBd9jxjocFC2w==", + "dev": true, + "engines": { + "node": "^12.17.0 || ^14.13 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/create-captain-app/node_modules/js-yaml": { + "version": "3.14.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz", + "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==", + "dev": true, + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/create-captain-app/node_modules/meow": { + "version": "13.2.0", + "resolved": "https://registry.npmjs.org/meow/-/meow-13.2.0.tgz", + "integrity": "sha512-pxQJQzB6djGPXh08dacEloMFopsOqGVRKFPYvPOt9XDZ1HasbgDZA74CJGreSU4G3Ak7EFJGoiH2auq+yXISgA==", + "dev": true, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/create-captain-app/node_modules/sprintf-js": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", + "integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==", + "dev": true + }, "node_modules/create-jest": { "version": "29.7.0", "dev": true, @@ -13778,6 +13858,33 @@ "ms": "^2.0.0" } }, + "node_modules/humanize-string": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/humanize-string/-/humanize-string-3.0.0.tgz", + "integrity": "sha512-jhWD2GAZRMELz0IEIfqpEdi0M4CMQF1GpJpBYIopFN6wT+78STiujfQTKcKqZzOJgUkIgJSo2xFeHdsg922JZQ==", + "dev": true, + "dependencies": { + "decamelize": "^6.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/humanize-string/node_modules/decamelize": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/decamelize/-/decamelize-6.0.0.tgz", + "integrity": "sha512-Fv96DCsdOgB6mdGl67MT5JaTNKRzrzill5OH5s8bjYJXVlcXyPYGyPsUkWyGV5p1TXI5esYIYMMeDJL0hEIwaA==", + "dev": true, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/husky": { "version": "9.0.11", "dev": true, @@ -24772,9 +24879,10 @@ } }, "node_modules/tar": { - "version": "6.2.0", + "version": "6.2.1", + "resolved": "https://registry.npmjs.org/tar/-/tar-6.2.1.tgz", + "integrity": "sha512-DZ4yORTwrbTj/7MZYq2w+/ZFdI6OZ/f9SFHR+71gIVUZhOQPHzVCLpvRnPgyaMpfWxxk/4ONva3GQSyNIKRv6A==", "dev": true, - "license": "ISC", "dependencies": { "chownr": "^2.0.0", "fs-minipass": "^2.0.0", diff --git a/package.json b/package.json index dd836343f..38e9b1a90 100644 --- a/package.json +++ b/package.json @@ -16,15 +16,20 @@ "coverage:merge": "nyc merge ./coverage/merge ./coverage/combined-coverage.json", "coverage:report": "nyc report --temp-dir ./coverage/merge --report-dir ./coverage/report --reporter lcov --reporter text", "dev": "nextron", - "typedoc:generate": "run-s typedoc:client typedoc:electron typedoc:shared", + "typedoc:generate": "run-p typedoc:client typedoc:electron typedoc:shared typedoc:create-captain-app typedoc:captn-**", "posttypedoc:generate": "node ./scripts/nextra-meta.mjs", - "typedoc:client": "run-s typedoc:client-atoms typedoc:client-ions typedoc:client-organisms", + "typedoc:client": "run-p typedoc:client-atoms typedoc:client-ions typedoc:client-organisms", "typedoc:client-atoms": "npx typedoc --options typedoc.client-atoms.json", "typedoc:client-ions": "npx typedoc --options typedoc.client-ions.json", "typedoc:client-molecules": "npx typedoc --options typedoc.client-molecules.json", "typedoc:client-organisms": "npx typedoc --options typedoc.client-organisms.json", "typedoc:electron": "npx typedoc --options typedoc.electron.json", "typedoc:shared": "npx typedoc --options typedoc.shared.json", + "typedoc:create-captain-app": "npx typedoc --options typedoc.create-captain-app.json", + "typedoc:captn-joy": "npx typedoc --options typedoc.captn-joy.json", + "typedoc:captn-react": "npx typedoc --options typedoc.captn-react.json", + "typedoc:captn-theme": "npx typedoc --options typedoc.captn-theme.json", + "typedoc:captn-utils": "npx typedoc --options typedoc.captn-utils.json", "eslint": "eslint \"src/{**/*,*}.{ts,tsx}\"", "postinstall": "electron-builder install-app-deps", "ncu": "npx npm-check-updates@latest -u", @@ -53,10 +58,10 @@ "sharp": "0.33.2" }, "devDependencies": { - "@captn/joy": "^0.24.0", - "@captn/react": "^0.24.0", - "@captn/theme": "^0.24.0", - "@captn/utils": "^0.24.0", + "@captn/joy": "^0.26.2", + "@captn/react": "^0.26.2", + "@captn/theme": "^0.26.2", + "@captn/utils": "^0.26.2", "@commitlint/cli": "^19.3.0", "@commitlint/config-conventional": "^19.2.2", "@dnd-kit/core": "^6.1.0", @@ -104,6 +109,7 @@ "axios": "^1.6.8", "conventional-changelog-cli": "^4.1.0", "cpy-cli": "^5.0.0", + "create-captain-app": "^0.26.2", "cross-env": "^7.0.3", "dayjs": "1.11.11", "docusaurus-plugin-typedoc": "^0.22.0", diff --git a/scripts/nextra-meta.mjs b/scripts/nextra-meta.mjs index b6e755530..3c1200e5b 100644 --- a/scripts/nextra-meta.mjs +++ b/scripts/nextra-meta.mjs @@ -3,8 +3,11 @@ import fs from "node:fs"; import path from "node:path"; // Define your source and destination directories using ESM syntax -const templateDirectory = path.join(process.cwd(), "homepage/pages/_captain-core"); -const outputDirectory = path.join(process.cwd(), "homepage/pages/captain-core"); +const templateDirectoryCore = path.join(process.cwd(), "homepage/pages/_captain-core"); +const outputDirectoryCore = path.join(process.cwd(), "homepage/pages/captain-core"); + +const templateDirectorySdk = path.join(process.cwd(), "homepage/pages/_captain-sdk"); +const outputDirectorySdk = path.join(process.cwd(), "homepage/pages/captain-sdk"); // Recursive function to copy files using ESM syntax function copyMetaFiles(source, destination) { @@ -22,9 +25,14 @@ function copyMetaFiles(source, destination) { } // Create the destination directory if it doesn't exist -if (!fs.existsSync(outputDirectory)) { - fs.mkdirSync(outputDirectory, { recursive: true }); +if (!fs.existsSync(outputDirectoryCore)) { + fs.mkdirSync(outputDirectoryCore, { recursive: true }); +} + +if (!fs.existsSync(outputDirectorySdk)) { + fs.mkdirSync(outputDirectorySdk, { recursive: true }); } // Start the copying process -copyMetaFiles(templateDirectory, outputDirectory); +copyMetaFiles(templateDirectoryCore, outputDirectoryCore); +copyMetaFiles(templateDirectorySdk, outputDirectorySdk); diff --git a/tsconfig.captn.json b/tsconfig.captn.json new file mode 100644 index 000000000..0b69bb857 --- /dev/null +++ b/tsconfig.captn.json @@ -0,0 +1,27 @@ +{ + "compilerOptions": { + "lib": ["dom", "dom.iterable", "esnext"], + "allowJs": true, + "skipLibCheck": true, + "strict": true, + "forceConsistentCasingInFileNames": true, + "noEmit": true, + "esModuleInterop": true, + "target": "ES2022", + "module": "ES2022", + "moduleResolution": "Bundler", + "resolveJsonModule": true, + "isolatedModules": true, + "jsx": "preserve", + "incremental": true, + "baseUrl": ".", + "paths": { + "@/client/*": ["./src/client/*"], + "@/electron/*": ["./src/electron/helpers/*"], + "@/shared/*": ["./src/shared/*"], + "~package": ["./package.json"], + "@site/*": ["./homepage/*"] + } + }, + "include": ["**/*.d.ts", "**/*.ts", "**/*.tsx", "node_modules/@captn/**/dist/esm/**/*.js", "node_modules/create-captain-app/**/dist/**/*.js"], +} diff --git a/typedoc.captn-joy.json b/typedoc.captn-joy.json new file mode 100644 index 000000000..f7abb1b9f --- /dev/null +++ b/typedoc.captn-joy.json @@ -0,0 +1,24 @@ +{ + "$schema": "https://typedoc.org/schema.json", + "tsconfig": "tsconfig.captn.json", + "out": "homepage/pages/captain-sdk/joy", + "entryPoints": ["node_modules/@captn/joy/dist/esm"], + "exclude": [ + "**/*.test.ts", + "**/__tests__/**", + "**/__mocks__/**", + "**/*.d.ts" + ], + "readme": "./node_modules/@captn/joy/README.md", + "entryPointStrategy": "expand", + "plugin": ["typedoc-plugin-markdown"], + "markedOptions": { + "gfm": true, + "tables": true + }, + "hideBreadcrumbs": true, + "excludePrivate": true, + "excludeProtected": true, + "excludeExternals": false, + "excludeReferences": true +} diff --git a/typedoc.captn-react.json b/typedoc.captn-react.json new file mode 100644 index 000000000..a8ea337e6 --- /dev/null +++ b/typedoc.captn-react.json @@ -0,0 +1,24 @@ +{ + "$schema": "https://typedoc.org/schema.json", + "tsconfig": "tsconfig.captn.json", + "out": "homepage/pages/captain-sdk/react", + "entryPoints": ["node_modules/@captn/react/dist/esm"], + "exclude": [ + "**/*.test.ts", + "**/__tests__/**", + "**/__mocks__/**", + "**/*.d.ts" + ], + "readme": "./node_modules/@captn/react/README.md", + "entryPointStrategy": "expand", + "plugin": ["typedoc-plugin-markdown"], + "markedOptions": { + "gfm": true, + "tables": true + }, + "hideBreadcrumbs": true, + "excludePrivate": true, + "excludeProtected": true, + "excludeExternals": false, + "excludeReferences": true +} diff --git a/typedoc.captn-theme.json b/typedoc.captn-theme.json new file mode 100644 index 000000000..c840cfde2 --- /dev/null +++ b/typedoc.captn-theme.json @@ -0,0 +1,24 @@ +{ + "$schema": "https://typedoc.org/schema.json", + "tsconfig": "tsconfig.captn.json", + "out": "homepage/pages/captain-sdk/theme", + "entryPoints": ["node_modules/@captn/theme/dist/esm"], + "exclude": [ + "**/*.test.ts", + "**/__tests__/**", + "**/__mocks__/**", + "**/*.d.ts" + ], + "readme": "./node_modules/@captn/theme/README.md", + "entryPointStrategy": "expand", + "plugin": ["typedoc-plugin-markdown"], + "markedOptions": { + "gfm": true, + "tables": true + }, + "hideBreadcrumbs": true, + "excludePrivate": true, + "excludeProtected": true, + "excludeExternals": false, + "excludeReferences": true +} diff --git a/typedoc.captn-utils.json b/typedoc.captn-utils.json new file mode 100644 index 000000000..08a27ecaa --- /dev/null +++ b/typedoc.captn-utils.json @@ -0,0 +1,24 @@ +{ + "$schema": "https://typedoc.org/schema.json", + "tsconfig": "tsconfig.captn.json", + "out": "homepage/pages/captain-sdk/utils", + "entryPoints": ["node_modules/@captn/utils/dist/esm"], + "exclude": [ + "**/*.test.ts", + "**/__tests__/**", + "**/__mocks__/**", + "**/*.d.ts" + ], + "readme": "./node_modules/@captn/utils/README.md", + "entryPointStrategy": "expand", + "plugin": ["typedoc-plugin-markdown"], + "markedOptions": { + "gfm": true, + "tables": true + }, + "hideBreadcrumbs": true, + "excludePrivate": true, + "excludeProtected": true, + "excludeExternals": false, + "excludeReferences": true +} diff --git a/typedoc.create-captain-app.json b/typedoc.create-captain-app.json new file mode 100644 index 000000000..3df76dcb2 --- /dev/null +++ b/typedoc.create-captain-app.json @@ -0,0 +1,24 @@ +{ + "$schema": "https://typedoc.org/schema.json", + "tsconfig": "tsconfig.captn.json", + "out": "homepage/pages/captain-sdk/create-captain-app", + "entryPoints": ["node_modules/create-captain-app/dist"], + "exclude": [ + "**/*.test.ts", + "**/__tests__/**", + "**/__mocks__/**", + "**/*.d.ts" + ], + "readme": "./node_modules/create-captain-app/README.md", + "entryPointStrategy": "expand", + "plugin": ["typedoc-plugin-markdown"], + "markedOptions": { + "gfm": true, + "tables": true + }, + "hideBreadcrumbs": true, + "excludePrivate": true, + "excludeProtected": true, + "excludeExternals": false, + "excludeReferences": true +}