Skip to content

Commit 7b26214

Browse files
committed
chore(typedoc): consolidate into single typedoc.json config
Remove the separate typedoc.html.json and make the HTML site config the default. Remove docs:html script (now redundant with docs).
1 parent f850db7 commit 7b26214

3 files changed

Lines changed: 11 additions & 33 deletions

File tree

package.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,7 @@
4545
"test": "turbo run _test",
4646
"test:coverage": "turbo run _test:coverage",
4747
"docs": "turbo run _docs:cli _docs:api",
48-
"docs:html": "turbo run _docs:cli _docs:api:html",
49-
"docs:serve": "typedoc --options typedoc.html.json --watch --serve",
48+
"docs:serve": "typedoc --watch --serve",
5049
"lint": "turbo run _lint",
5150
"spm": "tsx src/cli/index.ts",
5251
"_lint": "eslint --cache .",
@@ -57,7 +56,6 @@
5756
"_test:coverage": "c8 --src src --exclude 'src/cli/**' --exclude 'src/generate-schema.ts' tsx --test tests/*.test.ts",
5857
"_docs:cli": "tsx scripts/generate-cli-docs.ts",
5958
"_docs:api": "typedoc",
60-
"_docs:api:html": "typedoc --options typedoc.html.json",
6159
"prepare": "husky"
6260
},
6361
"dependencies": {

typedoc.html.json

Lines changed: 0 additions & 24 deletions
This file was deleted.

typedoc.json

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,19 @@
33
"entryPoints": ["./src"],
44
"entryPointStrategy": "expand",
55
"exclude": ["**/cli/**", "**/generate-schema.ts", "**/index.ts"],
6-
"out": "docs/api",
7-
"plugin": ["typedoc-plugin-markdown", "typedoc-plugin-zod"],
6+
"out": "site",
7+
"plugin": ["typedoc-plugin-zod"],
88
"name": "SysProM",
9-
"readme": "none",
9+
"readme": "README.md",
10+
"projectDocuments": ["docs/cli/README.md"],
1011
"excludePrivate": true,
1112
"excludeInternal": true,
12-
"expandObjects": false,
13-
"expandParameters": false,
14-
"typeDeclarationFormat": "table",
13+
"navigation": {
14+
"includeCategories": false,
15+
"includeGroups": false,
16+
"includeFolders": true,
17+
"compactFolders": false
18+
},
1519
"validation": {
1620
"notExported": true,
1721
"invalidLink": true,

0 commit comments

Comments
 (0)