diff --git a/docs/package.json b/docs/package.json index 18ef018b..70c1ad39 100644 --- a/docs/package.json +++ b/docs/package.json @@ -3,11 +3,12 @@ "version": "1.0.0", "private": true, "scripts": { - "dev": "pnpm run typedoc && vitepress dev src", - "build": "pnpm run typedoc && vitepress build src", + "dev": "pnpm run typedoc:md && vitepress dev src", + "build": "pnpm run typedoc:md && vitepress build src", "serve": "vitepress serve src", "lint": "eslint --ext \".js,.jsx,.ts,.tsx\" --fix --ignore-path .gitignore .", - "typedoc": "typedoc --options ./typedoc.json" + "typedoc:md": "typedoc --options ./typedoc.md.json", + "typedocs": "typedoc --options ./typedoc.json" }, "dependencies": { "@algolia/client-search": "^4.14.2", @@ -28,6 +29,9 @@ "@windicss/plugin-scrollbar": "^1.2.3", "dotenv": "^16.0.1", "ohmyfetch": "^0.4.18", + "typedoc": "^0.22.18", + "typedoc-plugin-markdown": "^3.13.4", + "typedoc-plugin-merge-modules": "^4.0.1", "unplugin-auto-import": "^0.10.3", "unplugin-icons": "^0.14.8", "unplugin-vue-components": "^0.21.2", diff --git a/tsconfig.docs.json b/docs/tsconfig.docs.json similarity index 78% rename from tsconfig.docs.json rename to docs/tsconfig.docs.json index acd7cbad..148e3011 100644 --- a/tsconfig.docs.json +++ b/docs/tsconfig.docs.json @@ -14,9 +14,9 @@ "strictNullChecks": true, "forceConsistentCasingInFileNames": true, "paths": { - "~/*": ["packages/vue-flow/src/*"] + "~/*": ["../packages/vue-flow/src/*"] } }, - "include": ["packages/vue-flow", "packages/additional-components"], + "include": ["../packages/vue-flow", "../packages/additional-components"], "exclude": ["node_modules"] } diff --git a/docs/typedoc.json b/docs/typedoc.json index 01fffb0c..4da5ad16 100644 --- a/docs/typedoc.json +++ b/docs/typedoc.json @@ -2,21 +2,17 @@ "$schema": "https://typedoc.org/schema.json", "readme": "none", "plugin": [ - "typedoc-plugin-merge-modules", - "typedoc-plugin-markdown" + "typedoc-plugin-merge-modules" ], "entryPoints": [ "../packages/vue-flow/src/index.ts", "../packages/additional-components/src/index.ts" ], - "allReflectionsHaveOwnDocument": true, "categorizeByGroup": true, "darkHighlightTheme": "vitesse-dark", "lightHighlightTheme": "vitesse-light", - "hideBreadcrumbs": true, "disableSources": true, "cleanOutputDir": true, - "out": "src/typedocs", - "tsconfig": "../tsconfig.docs.json", - "entryDocument": "index.md" + "out": "typedocs", + "tsconfig": "tsconfig.docs.json" } diff --git a/docs/typedoc.md.json b/docs/typedoc.md.json new file mode 100644 index 00000000..70e3c89c --- /dev/null +++ b/docs/typedoc.md.json @@ -0,0 +1,22 @@ +{ + "$schema": "https://typedoc.org/schema.json", + "readme": "none", + "plugin": [ + "typedoc-plugin-merge-modules", + "typedoc-plugin-markdown" + ], + "entryPoints": [ + "../packages/vue-flow/src/index.ts", + "../packages/additional-components/src/index.ts" + ], + "allReflectionsHaveOwnDocument": true, + "categorizeByGroup": true, + "darkHighlightTheme": "vitesse-dark", + "lightHighlightTheme": "vitesse-light", + "hideBreadcrumbs": true, + "disableSources": true, + "cleanOutputDir": true, + "out": "src/typedocs", + "tsconfig": "tsconfig.docs.json", + "entryDocument": "index.md" +} diff --git a/package.json b/package.json index 75d30205..7de9f927 100644 --- a/package.json +++ b/package.json @@ -9,8 +9,7 @@ "release": "turbo run release", "build": "turbo run build", "test": "turbo run test", - "lint": "turbo run lint", - "typedocs": "typedoc --options ./typedoc.json" + "lint": "turbo run lint" }, "devDependencies": { "@antfu/eslint-config": "^0.27.0", @@ -22,9 +21,6 @@ "prettier": "^2.7.1", "shx": "^0.3.4", "turbo": "^1.5.5", - "typedoc": "^0.22.18", - "typedoc-plugin-markdown": "^3.13.4", - "typedoc-plugin-merge-modules": "^4.0.1", "typescript": "4.7.4" } } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index c1bfe466..57fd31d8 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -13,9 +13,6 @@ importers: prettier: ^2.7.1 shx: ^0.3.4 turbo: ^1.5.5 - typedoc: ^0.22.18 - typedoc-plugin-markdown: ^3.13.4 - typedoc-plugin-merge-modules: ^4.0.1 typescript: 4.7.4 devDependencies: '@antfu/eslint-config': 0.27.0_yv3nvntfnealqm77uomj2fi4ki @@ -27,9 +24,6 @@ importers: prettier: 2.7.1 shx: 0.3.4 turbo: 1.5.5 - typedoc: 0.22.18_typescript@4.7.4 - typedoc-plugin-markdown: 3.13.4_typedoc@0.22.18 - typedoc-plugin-merge-modules: 4.0.1_typedoc@0.22.18 typescript: 4.7.4 docs: @@ -49,11 +43,14 @@ importers: canvas-confetti: ^1.5.1 dotenv: ^16.0.1 ohmyfetch: ^0.4.18 + typedoc: ^0.22.18 + typedoc-plugin-markdown: ^3.13.4 + typedoc-plugin-merge-modules: ^4.0.1 unplugin-auto-import: ^0.10.3 unplugin-icons: ^0.14.8 unplugin-vue-components: ^0.21.2 vite-plugin-windicss: ^1.8.7 - vitepress: 1.0.0-alpha.4 + vitepress: ^1.0.0-alpha.4 vue: ^3.2.37 windicss: ^3.5.6 dependencies: @@ -74,6 +71,9 @@ importers: '@windicss/plugin-scrollbar': 1.2.3 dotenv: 16.0.1 ohmyfetch: 0.4.18 + typedoc: 0.22.18_typescript@4.7.4 + typedoc-plugin-markdown: 3.13.4_typedoc@0.22.18 + typedoc-plugin-merge-modules: 4.0.1_typedoc@0.22.18 unplugin-auto-import: 0.10.3_vite@2.9.15 unplugin-icons: 0.14.8_vite@2.9.15 unplugin-vue-components: 0.21.2_vite@2.9.15+vue@3.2.37 diff --git a/typedoc.json b/typedoc.json deleted file mode 100644 index d6ae5800..00000000 --- a/typedoc.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "$schema": "https://typedoc.org/schema.json", - "readme": "none", - "plugin": [ - "typedoc-plugin-merge-modules" - ], - "entryPoints": [ - "packages/vue-flow/src/index.ts", - "packages/additional-components/src/index.ts" - ], - "categorizeByGroup": true, - "darkHighlightTheme": "vitesse-dark", - "lightHighlightTheme": "vitesse-light", - "disableSources": true, - "cleanOutputDir": true, - "out": "typedocs", - "tsconfig": "./tsconfig.docs.json" -}