Add typedoc docs (#583)

* Add typedoc docs * Fix security vulnerability detected in Marked
census-instrumentation · Nov 19, 2019 · 47bdce2 · 47bdce2
1 parent eabfd10
commit 47bdce2
Show file tree

Hide file tree

Showing 4 changed files with 177 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -37,3 +37,6 @@ build/
 
 #istanbul files
 coverage/
+
+#docs files
+docs
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -13,7 +13,8 @@
     "bootstrap": "lerna bootstrap",
     "bump": "lerna publish",
     "codecov": "lerna run codecov",
-    "check": "lerna run check"
+    "check": "lerna run check",
+    "docs": "typedoc --tsconfig  ./packages/opencensus-core/tsconfig.json"
   },
   "keywords": [
     "opencensus",
@@ -42,6 +43,7 @@
   "devDependencies": {
     "@types/node": "^10.12.12",
     "lerna": "^2.11.0",
+    "typedoc": "^0.14.2",
     "typescript": "^3.0.0"
   }
 }
diff --git a/packages/opencensus-core/tsconfig.json b/packages/opencensus-core/tsconfig.json
@@ -15,5 +15,12 @@
   ],
   "exclude": [
     "node_modules"
-  ]
+  ],
+  "typedocOptions": {
+    "name": "OpenCensus Documentation",
+    "out": "docs",
+    "mode": "file",
+    "hideGenerator": true,
+    "ignoreCompilerErrors": true
+  }
 }