Skip to content

Commit 280550a

Browse files
Add typedoc (documentation tool)
1 parent 1716d97 commit 280550a

File tree

3 files changed

+132
-1
lines changed

3 files changed

+132
-1
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# See http://help.github.com/ignore-files/ for more about ignoring files.
22
dist/
3+
doc/
34
# dependencies
45
node_modules
56
.env

package-lock.json

+128
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
@@ -32,6 +32,7 @@
3232
"rollup-plugin-node-resolve": "^3.0.0",
3333
"rollup-plugin-typescript2": "^0.20.1",
3434
"ts-jest": "^25.2.0",
35+
"typedoc": "^0.16.11",
3536
"typescript": "^3.5.1"
3637
},
3738
"scripts": {
@@ -41,7 +42,8 @@
4142
"lint": "eslint --max-warnings 0 --ext .ts,js src/",
4243
"prettier": "prettier --write \"{src,example,stories}/**/*.{ts,js}\"",
4344
"storybook": "start-storybook -p 6006",
44-
"build-storybook": "build-storybook"
45+
"build-storybook": "build-storybook",
46+
"build-doc": "typedoc --excludePrivate --excludeProtected --out doc/ src/"
4547
},
4648
"jest": {
4749
"moduleFileExtensions": [

0 commit comments

Comments
 (0)