Skip to content
This repository was archived by the owner on Jul 11, 2023. It is now read-only.

Commit 899fe3c

Browse files
committed
feat: initialize typedoc
1 parent 3da015b commit 899fe3c

File tree

3 files changed

+27
-1
lines changed

3 files changed

+27
-1
lines changed

package.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414
"test": "turbo run test",
1515
"build": "turbo run build",
1616
"update": "yarn upgrade-interactive",
17-
"check-update": "turbo run check-update"
17+
"check-update": "turbo run check-update",
18+
"docs": "typedoc"
1819
},
1920
"repository": {
2021
"type": "git",
@@ -53,6 +54,9 @@
5354
"ts-jest": "^28.0.1",
5455
"ts-node": "^10.7.0",
5556
"turbo": "latest",
57+
"typedoc": "^0.22.15",
58+
"typedoc-plugin-djs-links": "^1.0.4",
59+
"typedoc-plugin-mdn-links": "^1.0.6",
5660
"typescript": "4.6.4"
5761
},
5862
"dependencies": {

tsconfig.base.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@
33
"compilerOptions": {
44
"importHelpers": true,
55
"noEmitHelpers": true,
6+
"importsNotUsedAsValues": "remove"
67
}
78
}

typedoc.json

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"cleanOutputDir": true,
3+
"entryPointStrategy": "resolve",
4+
"entryPoints": [
5+
"packages/command-context/src/index.ts"
6+
],
7+
"excludeExternals": true,
8+
"externalPattern": ["node_modules/@types/**"],
9+
"hideGenerator": true,
10+
"lightHighlightTheme": "github-light",
11+
"darkHighlightTheme": "github-dark",
12+
"markedOptions": {
13+
"gfm": true,
14+
"mangle": false,
15+
"smartypants": true
16+
},
17+
"name": "Zhycorp Sapphire Plugins",
18+
"out": "./docs/",
19+
"readme": "./README.md",
20+
"tsconfig": "./tsconfig.dev.json"
21+
}

0 commit comments

Comments
 (0)