Skip to content

Commit 442f089

Browse files
committed
doc: add typedoc
1 parent f6ba957 commit 442f089

4 files changed

Lines changed: 151 additions & 0 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
*~
22
node_modules
33
coverage
4+
doc
45
playground
56
*.tgz

package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
],
2121
"scripts": {
2222
"lint": "eslint .",
23+
"typedoc": "typedoc",
2324
"test:javascriptcore": "npm run test:jsc --",
2425
"test:v8": "exodus-test --engine=v8:bundle",
2526
"test:jsc": "exodus-test --engine=jsc:bundle",
@@ -251,6 +252,7 @@
251252
"jsvu": "^3.0.3",
252253
"punycode": "^2.3.1",
253254
"text-encoding": "^0.7.0",
255+
"typedoc": "^0.28.16",
254256
"typescript": "^5.9.3",
255257
"uint8array-tools": "^0.0.9",
256258
"utf8": "^3.0.0",

pnpm-lock.yaml

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

typedoc.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"excludeNotDocumented": true,
3+
"excludeNotDocumentedKinds": ["Module"],
4+
"navigation": {
5+
"includeFolders": false
6+
},
7+
"outputs": [
8+
{
9+
"name": "html",
10+
"path": "./doc"
11+
},
12+
{
13+
"name": "json",
14+
"path": "./doc/index.json"
15+
}
16+
]
17+
}

0 commit comments

Comments
 (0)