Skip to content

Commit ccbd22f

Browse files
committed
- npm: Add typedoc (with npm scripts) for documenting
1 parent 0032b9e commit ccbd22f

File tree

2 files changed

+239
-10
lines changed

2 files changed

+239
-10
lines changed

package-lock.json

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

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@
7777
"rollup": "1.17.0",
7878
"rollup-plugin-babel": "^4.3.3",
7979
"rollup-plugin-terser": "^5.1.1",
80+
"typedoc": "^0.14.2",
8081
"typescript": "^3.5.3"
8182
},
8283
"keywords": [
@@ -89,6 +90,8 @@
8990
"scripts": {
9091
"remark": "remark -q -f .",
9192
"typescript": "tsc src/jsonpath.d.ts",
93+
"build-docs": "typedoc --out docs/ts src --includeDeclarations",
94+
"open-docs": "open-cli http://localhost:8084/docs/ts/ && npm start",
9295
"mocha": "mocha --require test-helpers/node-env.js test",
9396
"test": "npm run eslint && npm run rollup && npm run mocha",
9497
"start": "static -p 8084",

0 commit comments

Comments
 (0)