Skip to content

Commit 30295d2

Browse files
committed
fix typedoc docs building
* Build docs from generated types files
1 parent 34cb519 commit 30295d2

3 files changed

Lines changed: 22 additions & 2 deletions

File tree

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@
3535
"build": "npm run clean && tsc --build tsconfig.json --inlineSourceMap",
3636
"dev": "npm run build -- --watch",
3737
"build-dist": "npm run build -- --inlineSourceMap --listEmittedFiles",
38-
"docs": "npx typedoc --plugin typedoc-plugin-extras --out docs-build --cacheBust src/index.ts",
39-
"docs-dist": "npm run docs -- --gitRevision dev",
38+
"docs": "npx typedoc",
39+
"docs-dist": "npm run docs -- --gitRevision dist",
4040
"setup-examples": "cd examples/package && npm run setup-dev && cd ../project && npm run setup-dev",
4141
"build-examples": "cd examples/package && npm run build && cd ../project && npm run build"
4242
},

tsconfig.docs.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"$schema": "https://json.schemastore.org/tsconfig",
3+
"extends": "./tsconfig.json",
4+
"include": [
5+
"types/**/*.d.ts"
6+
],
7+
"compilerOptions": {
8+
"noEmit": true
9+
}
10+
}

typedoc.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
11
{
2+
"entryPoints": [
3+
"types/index.d.ts"
4+
],
5+
"tsconfig": "tsconfig.docs.json",
6+
"emit": "docs",
7+
"out": "./docs-build",
8+
"cacheBust": true,
9+
"plugin": [
10+
"typedoc-plugin-extras"
11+
],
212
"favicon": "https://nxtlvlsoftware.github.io/alpine-typescript/favicon.ico",
313
"footerTypedocVersion": true,
414
"footerDate": true,

0 commit comments

Comments
 (0)