Skip to content

Commit 1de0999

Browse files
committed
use typedoc to generate API docs
1 parent cce1dd2 commit 1de0999

File tree

4 files changed

+102
-1
lines changed

4 files changed

+102
-1
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ lerna-debug.log*
1010
node_modules
1111
dist
1212
dist-ssr
13+
docs
1314
*.local
1415
*.tgz
1516

package-lock.json

+94
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+3-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
"dev": "vite",
1616
"build": "tsc && vite build",
1717
"preview": "vite preview",
18-
"test": "vitest"
18+
"test": "vitest",
19+
"doc": "typedoc"
1920
},
2021
"dependencies": {
2122
"@scdh/seed-xml-transformer-ts-client": "0.1.0",
@@ -24,6 +25,7 @@
2425
},
2526
"devDependencies": {
2627
"saxon-js": "^2.6.0",
28+
"typedoc": "^0.25.3",
2729
"typescript": "^5.0.2",
2830
"typescript-plugin-css-modules": "^5.0.1",
2931
"vite": "^4.3.2",

typedoc.json

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"entryPoints": [ "src/*.ts" ],
3+
"out": "docs"
4+
}

0 commit comments

Comments
 (0)