docs: create typedoc theme and plugins for references (#5297)

* update typedoc and its plugins

* refactor existing typedoc configurations

* added new typedoc plugin and themes

* added more customization options

* added more customization options

* refactored doc-utils to a workspace

* fix tsconfig

* update README files

* remove comments

* revert type changes

* remove dependencies no longer needed

* removed modules action
This commit is contained in:
Shahed Nasser
2023-10-05 12:09:42 +03:00
committed by GitHub
parent b3f75d8f21
commit 0350eeb0a1
110 changed files with 7182 additions and 930 deletions
+6 -216
View File
@@ -4744,7 +4744,7 @@ __metadata:
languageName: node
linkType: hard
"@graphql-typed-document-node/core@npm:^3.1.0, @graphql-typed-document-node/core@npm:^3.1.1":
"@graphql-typed-document-node/core@npm:^3.1.1":
version: 3.2.0
resolution: "@graphql-typed-document-node/core@npm:3.2.0"
peerDependencies:
@@ -6080,17 +6080,6 @@ __metadata:
languageName: node
linkType: hard
"@linear/sdk@npm:^1.22.0":
version: 1.22.0
resolution: "@linear/sdk@npm:1.22.0"
dependencies:
"@graphql-typed-document-node/core": ^3.1.0
graphql: ^15.4.0
isomorphic-unfetch: ^3.1.0
checksum: 7e8f24f617631d027fd606334a498b04014d4c33603bcb3e08073d14f86260d116597983567f8bc147a935e4557180158175b52b9a9a8a270a234b946894a82b
languageName: node
linkType: hard
"@lmdb/lmdb-darwin-arm64@npm:2.5.2":
version: 2.5.2
resolution: "@lmdb/lmdb-darwin-arm64@npm:2.5.2"
@@ -7471,91 +7460,6 @@ __metadata:
languageName: node
linkType: hard
"@octokit/auth-token@npm:^3.0.0":
version: 3.0.4
resolution: "@octokit/auth-token@npm:3.0.4"
checksum: abdf5e2da36344de9727c70ba782d58004f5ae1da0f65fa9bc9216af596ef23c0e4675f386df2f6886806612558091d603564051b693b0ad1986aa6160b7a231
languageName: node
linkType: hard
"@octokit/core@npm:^4.0.5":
version: 4.2.4
resolution: "@octokit/core@npm:4.2.4"
dependencies:
"@octokit/auth-token": ^3.0.0
"@octokit/graphql": ^5.0.0
"@octokit/request": ^6.0.0
"@octokit/request-error": ^3.0.0
"@octokit/types": ^9.0.0
before-after-hook: ^2.2.0
universal-user-agent: ^6.0.0
checksum: e54081a56884e628d1804837fddcd48c10d516117bb891551c8dc9d8e3dad449aeb9b4677ca71e8f0e76268c2b7656c953099506679aaa4666765228474a3ce6
languageName: node
linkType: hard
"@octokit/endpoint@npm:^7.0.0":
version: 7.0.6
resolution: "@octokit/endpoint@npm:7.0.6"
dependencies:
"@octokit/types": ^9.0.0
is-plain-object: ^5.0.0
universal-user-agent: ^6.0.0
checksum: fd147a55010b54af7567bf90791359f7096a1c9916a2b7c72f8afd0c53141338b3d78da3a4ab3e3bdfeb26218a1b73735432d8987ccc04996b1019219299f115
languageName: node
linkType: hard
"@octokit/graphql@npm:^5.0.0":
version: 5.0.6
resolution: "@octokit/graphql@npm:5.0.6"
dependencies:
"@octokit/request": ^6.0.0
"@octokit/types": ^9.0.0
universal-user-agent: ^6.0.0
checksum: de1d839d97fe6d96179925f6714bf96e7af6f77929892596bb4211adab14add3291fc5872b269a3d0e91a4dcf248d16096c82606c4a43538cf241b815c2e2a36
languageName: node
linkType: hard
"@octokit/openapi-types@npm:^18.0.0":
version: 18.0.0
resolution: "@octokit/openapi-types@npm:18.0.0"
checksum: d90fab10d962be71e72b85ffab2055cffd9c3196ff1edc3e4106deb78e99e8782965cf7aa6a4c1398f828e4d0c3e0f905915debfe34396d956dfce8e75b21664
languageName: node
linkType: hard
"@octokit/request-error@npm:^3.0.0":
version: 3.0.3
resolution: "@octokit/request-error@npm:3.0.3"
dependencies:
"@octokit/types": ^9.0.0
deprecation: ^2.0.0
once: ^1.4.0
checksum: 1e252ac193c8af23b709909911aa327ed5372cbafcba09e4aff41e0f640a7c152579ab0a60311a92e37b4e7936392d59ee4c2feae5cdc387ee8587a33d8afa60
languageName: node
linkType: hard
"@octokit/request@npm:^6.0.0":
version: 6.2.8
resolution: "@octokit/request@npm:6.2.8"
dependencies:
"@octokit/endpoint": ^7.0.0
"@octokit/request-error": ^3.0.0
"@octokit/types": ^9.0.0
is-plain-object: ^5.0.0
node-fetch: ^2.6.7
universal-user-agent: ^6.0.0
checksum: 6b6079ed45bac44c4579b40990bfd1905b03d4bc4e5255f3d5a10cf5182171578ebe19abeab32ebb11a806f1131947f2a06b7a077bd7e77ade7b15fe2882174b
languageName: node
linkType: hard
"@octokit/types@npm:^9.0.0":
version: 9.3.2
resolution: "@octokit/types@npm:9.3.2"
dependencies:
"@octokit/openapi-types": ^18.0.0
checksum: 2925479aa378a4491762b4fcf381bdc7daca39b4e0b2dd7062bce5d74a32ed7d79d20d3c65ceaca6d105cf4b1f7417fea634219bf90f79a57d03e2dac629ec45
languageName: node
linkType: hard
"@open-draft/until@npm:^1.0.3":
version: 1.0.3
resolution: "@open-draft/until@npm:1.0.3"
@@ -17079,13 +16983,6 @@ __metadata:
languageName: node
linkType: hard
"before-after-hook@npm:^2.2.0":
version: 2.2.3
resolution: "before-after-hook@npm:2.2.3"
checksum: 0488c4ae12df758ca9d49b3bb27b47fd559677965c52cae7b335784724fb8bf96c42b6e5ba7d7afcbc31facb0e294c3ef717cc41c5bc2f7bd9e76f8b90acd31c
languageName: node
linkType: hard
"better-opn@npm:^2.1.1":
version: 2.1.1
resolution: "better-opn@npm:2.1.1"
@@ -20535,13 +20432,6 @@ __metadata:
languageName: node
linkType: hard
"deprecation@npm:^2.0.0":
version: 2.3.1
resolution: "deprecation@npm:2.3.1"
checksum: 23d688ba66b74d09b908c40a76179418acbeeb0bfdf218c8075c58ad8d0c315130cb91aa3dffb623aa3a411a3569ce56c6460de6c8d69071c17fe6dd2442f032
languageName: node
linkType: hard
"dequal@npm:^2.0.3":
version: 2.0.3
resolution: "dequal@npm:2.0.3"
@@ -25235,7 +25125,7 @@ __metadata:
languageName: node
linkType: hard
"graphql@npm:^15.4.0, graphql@npm:^15.5.1, graphql@npm:^15.7.2":
"graphql@npm:^15.5.1, graphql@npm:^15.7.2":
version: 15.8.0
resolution: "graphql@npm:15.8.0"
checksum: 30cc09b77170a9d1ed68e4c017ec8c5265f69501c96e4f34f8f6613f39a886c96dd9853eac925f212566ed651736334c8fe24ceae6c44e8d7625c95c3009a801
@@ -27245,7 +27135,7 @@ __metadata:
languageName: node
linkType: hard
"is-plain-object@npm:5.0.0, is-plain-object@npm:^5.0.0":
"is-plain-object@npm:5.0.0":
version: 5.0.0
resolution: "is-plain-object@npm:5.0.0"
checksum: 893e42bad832aae3511c71fd61c0bf61aa3a6d853061c62a307261842727d0d25f761ce9379f7ba7226d6179db2a3157efa918e7fe26360f3bf0842d9f28942c
@@ -30338,7 +30228,7 @@ __metadata:
languageName: node
linkType: hard
"jsonc-parser@npm:^3.0.0, jsonc-parser@npm:^3.2.0":
"jsonc-parser@npm:^3.2.0":
version: 3.2.0
resolution: "jsonc-parser@npm:3.2.0"
checksum: 5a12d4d04dad381852476872a29dcee03a57439574e4181d91dca71904fcdcc5e8e4706c0a68a2c61ad9810e1e1c5806b5100d52d3e727b78f5cdc595401045b
@@ -31662,7 +31552,7 @@ __metadata:
languageName: node
linkType: hard
"marked@npm:^4.0.15, marked@npm:^4.0.18":
"marked@npm:^4.0.15":
version: 4.3.0
resolution: "marked@npm:4.3.0"
bin:
@@ -33034,7 +32924,7 @@ __metadata:
languageName: node
linkType: hard
"minimatch@npm:^5.0.1, minimatch@npm:^5.1.0":
"minimatch@npm:^5.0.1":
version: 5.1.6
resolution: "minimatch@npm:5.1.6"
dependencies:
@@ -39412,8 +39302,6 @@ __metadata:
"@babel/runtime": ^7.11.2
"@changesets/changelog-github": ^0.4.8
"@changesets/cli": ^2.26.0
"@linear/sdk": ^1.22.0
"@octokit/core": ^4.0.5
"@typescript-eslint/eslint-plugin": ^5.53.0
"@typescript-eslint/parser": ^5.53.0
axios: ^0.21.4
@@ -39443,12 +39331,6 @@ __metadata:
ts-jest: ^26.5.6
ts-node: ^10.9.1
turbo: ^1.6.3
typedoc: 0.23.10
typedoc-frontmatter-plugin: "link:docs-util/typedoc-plugins/typedoc-frontmatter-plugin"
typedoc-monorepo-link-types: ^0.0.2
typedoc-plugin-markdown: ^3.13.4
typedoc-plugin-merge-modules: ^4.0.1
typedoc-plugin-reference-excluder: ^1.0.0
typeorm: ^0.3.16
languageName: unknown
linkType: soft
@@ -40148,17 +40030,6 @@ __metadata:
languageName: node
linkType: hard
"shiki@npm:^0.10.1":
version: 0.10.1
resolution: "shiki@npm:0.10.1"
dependencies:
jsonc-parser: ^3.0.0
vscode-oniguruma: ^1.6.1
vscode-textmate: 5.2.0
checksum: cc4db3462722261cb9ce0f7c0dbe278af3b99ad57dfab77b80c4dc9c8e3198f1d3f3c3433044a731c16f7afede9e60747f8a62290fbbaa18c26026f7b94cde8b
languageName: node
linkType: hard
"should-equal@npm:^2.0.0":
version: 2.0.0
resolution: "should-equal@npm:2.0.0"
@@ -43125,66 +42996,6 @@ __metadata:
languageName: node
linkType: hard
"typedoc-frontmatter-plugin@link:docs-util/typedoc-plugins/typedoc-frontmatter-plugin::locator=root%40workspace%3A.":
version: 0.0.0-use.local
resolution: "typedoc-frontmatter-plugin@link:docs-util/typedoc-plugins/typedoc-frontmatter-plugin::locator=root%40workspace%3A."
languageName: node
linkType: soft
"typedoc-monorepo-link-types@npm:^0.0.2":
version: 0.0.2
resolution: "typedoc-monorepo-link-types@npm:0.0.2"
peerDependencies:
typedoc: 0.22.x
checksum: f282e6c0b1becdc36fd3cce5f4a79573b31098ec64c4e92bc17cc9001920e4e196b2973fa666f027643da5d34cbf3344c768a0ffd8f1907e04416b20c0af6ce6
languageName: node
linkType: hard
"typedoc-plugin-markdown@npm:^3.13.4":
version: 3.15.3
resolution: "typedoc-plugin-markdown@npm:3.15.3"
dependencies:
handlebars: ^4.7.7
peerDependencies:
typedoc: ">=0.24.0"
checksum: 573a5c103843b7b0035bedb0bac8ea34f842e8e63ade154d680c58fe6720e6fe7f9a48e3c3062021411d4710a4b06af32a6687d9d50b2c7a0512147dafeac060
languageName: node
linkType: hard
"typedoc-plugin-merge-modules@npm:^4.0.1":
version: 4.1.0
resolution: "typedoc-plugin-merge-modules@npm:4.1.0"
peerDependencies:
typedoc: 0.23.x || 0.24.x
checksum: e57fdef4a07e8fb83ff6e3c49e6f6461fa6412552346c16ad6f861f9343255cc55aa6e55d9ff69bc90fc5ccd2a95b476169097d1fc6d2c3ee729bf6983364e84
languageName: node
linkType: hard
"typedoc-plugin-reference-excluder@npm:^1.0.0":
version: 1.1.3
resolution: "typedoc-plugin-reference-excluder@npm:1.1.3"
peerDependencies:
typedoc: ">=0.22.0"
checksum: df3ffb7cade292d8f3001d41d541e11644b04b120c96ef7dad417ee4e75caf1aeffcfbb4ec025251c6510e82b690596087b9bdf79f3bbcdb8f968d1e5bb53e74
languageName: node
linkType: hard
"typedoc@npm:0.23.10":
version: 0.23.10
resolution: "typedoc@npm:0.23.10"
dependencies:
lunr: ^2.3.9
marked: ^4.0.18
minimatch: ^5.1.0
shiki: ^0.10.1
peerDependencies:
typescript: 4.6.x || 4.7.x
bin:
typedoc: bin/typedoc
checksum: 634e805a608c699811a0fa10944823504f0023afd599037298700179f2293cd717a937b32cf885c6bcf4808334f3132aaa9c946e63b9131789a9a9b240cb0115
languageName: node
linkType: hard
"typeorm@npm:^0.3.16":
version: 0.3.17
resolution: "typeorm@npm:0.3.17"
@@ -43644,13 +43455,6 @@ __metadata:
languageName: node
linkType: hard
"universal-user-agent@npm:^6.0.0":
version: 6.0.0
resolution: "universal-user-agent@npm:6.0.0"
checksum: ebeb0206963666c13bcf9ebc86d0577c7daed5870c05cd34d4972ee7a43b9ef20679baf2a8c83bf1b71d899bae67243ac4982d84ddaf9ba0355ff76595819961
languageName: node
linkType: hard
"universalify@npm:^0.1.0":
version: 0.1.2
resolution: "universalify@npm:0.1.2"
@@ -44361,20 +44165,6 @@ __metadata:
languageName: node
linkType: hard
"vscode-oniguruma@npm:^1.6.1":
version: 1.7.0
resolution: "vscode-oniguruma@npm:1.7.0"
checksum: bef0073c665ddf8c86e51da94529c905856559e9aba97a9882f951acd572da560384775941ab6e7e8db94d9c578b25fefb951e4b73c37e8712e16b0231de2689
languageName: node
linkType: hard
"vscode-textmate@npm:5.2.0":
version: 5.2.0
resolution: "vscode-textmate@npm:5.2.0"
checksum: 87c4786606cf7a49d78b690b37236f919db594ff81f1a405f9d9a0a9ee66ff3450fe51c0d8731f270268f7be550adffb6711a4bbc6f56d76b71abe41949817c7
languageName: node
linkType: hard
"vue-template-compiler@npm:^2.6.11":
version: 2.7.14
resolution: "vue-template-compiler@npm:2.7.14"