Skip to content

Commit c759691

Browse files
authored
docs(typedoc): update to latest, fix json generation, configs per package (#132)
1 parent 4dd592a commit c759691

10 files changed

Lines changed: 350 additions & 229 deletions

File tree

.azure-pipelines/api-docs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ steps:
6868
- task: ArchiveFiles@1
6969
displayName: 'Archive $(npmBuildTag) TypeDoc'
7070
inputs:
71-
rootFolder: '$(build.sourcesDirectory)/typedocs'
71+
rootFolder: '$(build.sourcesDirectory)/typedocs/legacy'
7272
includeRootFolder: false
7373
archiveType: zip
7474
archiveFile: '$(Build.ArtifactStagingDirectory)/TypeDocOutput.zip'
@@ -83,7 +83,7 @@ steps:
8383
displayName: 'Archive Production TypeDoc'
8484
condition: eq(variables['npmBuildTag'], 'prod')
8585
inputs:
86-
rootFolder: '$(build.sourcesDirectory)/typedocs'
86+
rootFolder: '$(build.sourcesDirectory)/typedocs/legacy'
8787
includeRootFolder: false
8888
archiveType: zip
8989
archiveFile: '$(Build.ArtifactStagingDirectory)/TypeDocOutputProduction.zip'

package-lock.json

Lines changed: 36 additions & 44 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,11 @@
99
"build:docs:dev": "cross-env NODE_ENV=\"development\" npm run build:typedoc",
1010
"build:docs:staging": "cross-env NODE_ENV=\"staging\" npm run build:typedoc",
1111
"build:docs:prod": "cross-env NODE_ENV=\"production\" npm run build:typedoc",
12-
"build:typedoc": "npm run build:plugin && typedoc",
12+
"build:typedoc": "npm run build:plugin && typedoc --options ./typedoc.legacy.json",
13+
"build:typedoc:components": "typedoc --options ./typedoc.components.json",
14+
"build:typedoc:dock-manager": "typedoc --options ./typedoc.dock-manager.json",
15+
"build:typedoc:grids": "typedoc --options ./typedoc.grids.json",
16+
"build:typedoc:exports": "npm run build:typedoc:components && npm run build:typedoc:dock-manager && npm run build:typedoc:grids",
1317
"build:plugin": "tsc --project ./plugins/typedoc-plugin-react-components/tsconfig.json",
1418
"build:plugin:watch": "tsc --project ./plugins/typedoc-plugin-react-components/tsconfig.json --watch",
1519
"build:plugin:prod": "tsc --project ./plugins/typedoc-plugin-react-components/tsconfig.prod.json",
@@ -42,7 +46,7 @@
4246
"@vitest/coverage-v8": "^4.0.18",
4347
"cross-env": "^7.0.3",
4448
"dompurify": "^3.4.0",
45-
"ig-typedoc-theme": "^6.2.3",
49+
"ig-typedoc-theme": "^7.0.1",
4650
"lefthook": "^2.1.1",
4751
"marked": "^17.0.3",
4852
"marked-shiki": "^1.2.1",
@@ -53,8 +57,9 @@
5357
"rimraf": "^6.1.3",
5458
"shiki": "^3.21.0",
5559
"tsx": "^4.21.0",
56-
"typedoc": "^0.27.9",
57-
"typedoc-plugin-localization": "^3.0.6",
60+
"typedoc": "^0.28.17",
61+
"typedoc-plugin-localization": "^3.1.0",
62+
"typedoc-plugin-merge-modules": "^7.0.0",
5863
"typescript": "^5.8.3",
5964
"vite": "^7.3.2",
6065
"vite-tsconfig-paths": "^6.1.1",

plugins/typedoc-plugin-react-components/package.json

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,14 @@
55
"type": "module",
66
"main": "./dist/main.js",
77
"keywords": [
8-
"typedoc-plugin"
9-
],
8+
"typedoc-plugin"
9+
],
1010
"scripts": {
11-
"build": "rm -tf dist/ && tsc",
11+
"build": "tsc",
1212
"watch": "tsc --watch",
1313
"test": "vitest run"
1414
},
15-
"dependencies": {
16-
},
15+
"dependencies": {},
1716
"devDependencies": {
1817
"@types/react": "^19.1.2",
1918
"@types/node": "^22.14.1",

0 commit comments

Comments
 (0)