From 6aaef2743d44bd1bb56ce10634c1d24aa2d15569 Mon Sep 17 00:00:00 2001 From: braks <78412429+bcakmakoglu@users.noreply.github.com> Date: Sat, 8 Oct 2022 21:32:13 +0200 Subject: [PATCH] docs: move typedoc to root deps --- docs/package.json | 3 --- docs/typedoc.json | 2 +- package.json | 5 ++++- packages/vue-flow/typedoc.json | 6 ------ docs/tsconfig.docs.json => tsconfig.docs.json | 4 ++-- turbo.json | 4 ---- typedoc.json | 18 ++++++++++++++++++ 7 files changed, 25 insertions(+), 17 deletions(-) delete mode 100644 packages/vue-flow/typedoc.json rename docs/tsconfig.docs.json => tsconfig.docs.json (78%) create mode 100644 typedoc.json diff --git a/docs/package.json b/docs/package.json index 1c1247a3..18ef018b 100644 --- a/docs/package.json +++ b/docs/package.json @@ -28,9 +28,6 @@ "@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/docs/typedoc.json b/docs/typedoc.json index 84b95a61..01fffb0c 100644 --- a/docs/typedoc.json +++ b/docs/typedoc.json @@ -17,6 +17,6 @@ "disableSources": true, "cleanOutputDir": true, "out": "src/typedocs", - "tsconfig": "./tsconfig.docs.json", + "tsconfig": "../tsconfig.docs.json", "entryDocument": "index.md" } diff --git a/package.json b/package.json index a2d8093a..7bad5916 100644 --- a/package.json +++ b/package.json @@ -10,7 +10,7 @@ "build": "turbo run build", "test": "turbo run test", "lint": "turbo run lint", - "typedocs": "turbo run typedoc" + "typedocs": "typedoc --options ./typedoc.json" }, "devDependencies": { "@antfu/eslint-config": "^0.27.0", @@ -22,6 +22,9 @@ "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.8.4" } } diff --git a/packages/vue-flow/typedoc.json b/packages/vue-flow/typedoc.json deleted file mode 100644 index 5422fc98..00000000 --- a/packages/vue-flow/typedoc.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "$schema": "https://typedoc.org/schema.json", - "entryPoints": ["./src/index.ts"], - "out": "typedocs", - "tsconfig": "./tsconfig.docs.json" -} diff --git a/docs/tsconfig.docs.json b/tsconfig.docs.json similarity index 78% rename from docs/tsconfig.docs.json rename to tsconfig.docs.json index 148e3011..acd7cbad 100644 --- a/docs/tsconfig.docs.json +++ b/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/turbo.json b/turbo.json index 96888559..510e7bc4 100644 --- a/turbo.json +++ b/turbo.json @@ -1,6 +1,5 @@ { "$schema": "https://turborepo.org/schema.json", - "baseBranch": "origin/master", "pipeline": { "build": { "dependsOn": ["^build", "types", "theme"], @@ -11,9 +10,6 @@ "dependsOn": ["^build"], "outputs": ["dist/**"] }, - "typedoc": { - "outputs": ["typedocs/**"] - }, "theme": { "outputs": ["dist/**"] }, diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 00000000..d6ae5800 --- /dev/null +++ b/typedoc.json @@ -0,0 +1,18 @@ +{ + "$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" +}