Skip to content

Commit a483b36

Browse files
committed
(#87) Added typedoc and config
1 parent f0cf782 commit a483b36

File tree

3 files changed

+141
-22
lines changed

3 files changed

+141
-22
lines changed

Diff for: package-lock.json

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

Diff for: package.json

+4-2
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,14 @@
5151
"lint": "tslint -p tsconfig.json",
5252
"watch": "tsc -w -p .",
5353
"prepublishOnly": "npm run compile && npm test",
54-
"versionBump": "bump --tag --push --all"
54+
"versionBump": "bump --tag --push --all",
55+
"typedoc": "typedoc --options ./typedoc.js --out ./docs lib/"
5556
},
5657
"dependencies": {
58+
"@nut-tree/libnut": "1.0.2",
5759
"clipboardy": "2.0.0",
5860
"opencv4nodejs-prebuilt": "5.3.0",
59-
"@nut-tree/libnut": "1.0.2"
61+
"typedoc": "^0.15.0"
6062
},
6163
"devDependencies": {
6264
"@types/clipboardy": "^1.1.0",

Diff for: typedoc.js

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
module.exports = {
2+
"mode": "file",
3+
exclude: [
4+
'**/dist/**',
5+
'**/node_modules/**',
6+
'**/*.spec.ts',
7+
'**/__mocks__/**',
8+
],
9+
readme: 'README.md',
10+
excludePrivate: true,
11+
skipInternal: true,
12+
excludeExternals: true,
13+
excludeProtected: true,
14+
includeDeclarations: false,
15+
hideGenerator: true,
16+
theme: 'default',
17+
};

0 commit comments

Comments
 (0)