Skip to content
This repository was archived by the owner on Oct 3, 2023. It is now read-only.

Commit 47bdce2

Browse files
authored
Add typedoc docs (#583)
* Add typedoc docs * Fix security vulnerability detected in Marked
1 parent eabfd10 commit 47bdce2

File tree

4 files changed

+177
-2
lines changed

4 files changed

+177
-2
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,6 @@ build/
3737

3838
#istanbul files
3939
coverage/
40+
41+
#docs files
42+
docs

package-lock.json

Lines changed: 163 additions & 0 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 & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@
1313
"bootstrap": "lerna bootstrap",
1414
"bump": "lerna publish",
1515
"codecov": "lerna run codecov",
16-
"check": "lerna run check"
16+
"check": "lerna run check",
17+
"docs": "typedoc --tsconfig ./packages/opencensus-core/tsconfig.json"
1718
},
1819
"keywords": [
1920
"opencensus",
@@ -42,6 +43,7 @@
4243
"devDependencies": {
4344
"@types/node": "^10.12.12",
4445
"lerna": "^2.11.0",
46+
"typedoc": "^0.14.2",
4547
"typescript": "^3.0.0"
4648
}
4749
}

packages/opencensus-core/tsconfig.json

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,12 @@
1515
],
1616
"exclude": [
1717
"node_modules"
18-
]
18+
],
19+
"typedocOptions": {
20+
"name": "OpenCensus Documentation",
21+
"out": "docs",
22+
"mode": "file",
23+
"hideGenerator": true,
24+
"ignoreCompilerErrors": true
25+
}
1926
}

0 commit comments

Comments
 (0)