Skip to content

Update typedoc to latest and fix json generation. Add typedoc configs per package. #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
skrustev wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Update typedoc to latest and fix json generation. Add typedoc configs per package. #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
fe223a3
fix(typedoc): Remove circular dependency in comments in typedoc. Upda…
skrustev Mar 19, 2026
003c724
feat(typedoc): Separate package builds.
skrustev Mar 19, 2026
62ac4a1
fix(typedoc): Fix base class properties not registered.
skrustev Mar 23, 2026
d86d80f
fix(typedoc): Exclude more types for base props.
skrustev Mar 23, 2026
8a0a2e7
Merge branch 'master' into skrastev/typedoc-json
skrustev Apr 15, 2026
a14d25f
chore(*): Update prod target folder.
skrustev Apr 15, 2026
c33c02a
chore(*): Add safety check from suggestion.
skrustev Apr 15, 2026
94f1976
Merge branch 'master' into skrastev/typedoc-json
skrustev Apr 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .azure-pipelines/api-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ steps:
- task: ArchiveFiles@1
displayName: 'Archive $(npmBuildTag) TypeDoc'
inputs:
rootFolder: '$(build.sourcesDirectory)/typedocs'
rootFolder: '$(build.sourcesDirectory)/typedocs/legacy'
includeRootFolder: false
archiveType: zip
archiveFile: '$(Build.ArtifactStagingDirectory)/TypeDocOutput.zip'
Expand All @@ -83,7 +83,7 @@ steps:
displayName: 'Archive Production TypeDoc'
condition: eq(variables['npmBuildTag'], 'prod')
inputs:
rootFolder: '$(build.sourcesDirectory)/typedocs'
rootFolder: '$(build.sourcesDirectory)/typedocs/legacy'
includeRootFolder: false
archiveType: zip
archiveFile: '$(Build.ArtifactStagingDirectory)/TypeDocOutputProduction.zip'
Expand Down
80 changes: 36 additions & 44 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 9 additions & 4 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,11 @@
"build:docs:dev": "cross-env NODE_ENV=\"development\" npm run build:typedoc",
"build:docs:staging": "cross-env NODE_ENV=\"staging\" npm run build:typedoc",
"build:docs:prod": "cross-env NODE_ENV=\"production\" npm run build:typedoc",
"build:typedoc": "npm run build:plugin && typedoc",
"build:typedoc": "npm run build:plugin && typedoc --options ./typedoc.legacy.json",
"build:typedoc:components": "typedoc --options ./typedoc.components.json",
"build:typedoc:dock-manager": "typedoc --options ./typedoc.dock-manager.json",
"build:typedoc:grids": "typedoc --options ./typedoc.grids.json",
"build:typedoc:exports": "npm run build:typedoc:components && npm run build:typedoc:dock-manager && npm run build:typedoc:grids",
Comment thread
skrustev marked this conversation as resolved.
"build:plugin": "tsc --project ./plugins/typedoc-plugin-react-components/tsconfig.json",
"build:plugin:watch": "tsc --project ./plugins/typedoc-plugin-react-components/tsconfig.json --watch",
"build:plugin:prod": "tsc --project ./plugins/typedoc-plugin-react-components/tsconfig.prod.json",
Expand Down Expand Up @@ -42,7 +46,7 @@
"@vitest/coverage-v8": "^4.0.18",
"cross-env": "^7.0.3",
"dompurify": "^3.4.0",
"ig-typedoc-theme": "^6.2.3",
"ig-typedoc-theme": "^7.0.1",
"lefthook": "^2.1.1",
"marked": "^17.0.3",
"marked-shiki": "^1.2.1",
Expand All @@ -53,8 +57,9 @@
"rimraf": "^6.1.3",
"shiki": "^3.21.0",
"tsx": "^4.21.0",
"typedoc": "^0.27.9",
"typedoc-plugin-localization": "^3.0.6",
"typedoc": "^0.28.17",
"typedoc-plugin-localization": "^3.1.0",
"typedoc-plugin-merge-modules": "^7.0.0",
"typescript": "^5.8.3",
"vite": "^7.3.2",
"vite-tsconfig-paths": "^6.1.1",
Expand Down
9 changes: 4 additions & 5 deletions plugins/typedoc-plugin-react-components/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,14 @@
"type": "module",
"main": "./dist/main.js",
"keywords": [
"typedoc-plugin"
],
"typedoc-plugin"
],
"scripts": {
"build": "rm -tf dist/ && tsc",
"build": "tsc",
"watch": "tsc --watch",
Comment thread
skrustev marked this conversation as resolved.
"test": "vitest run"
},
"dependencies": {
},
"dependencies": {},
"devDependencies": {
"@types/react": "^19.1.2",
"@types/node": "^22.14.1",
Expand Down
Loading
Loading