Add API documentation

konrad-powazka · Sep 23, 2018 · 06f3ce5 · 06f3ce5
1 parent 22dbff4
commit 06f3ce5
Show file tree

Hide file tree

Showing 11 changed files with 352 additions and 15 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 dist
 tests/bin
-node_modules
+node_modules
+docs
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -17,6 +17,7 @@
     "mocha": "^5.2.0",
     "rimraf": "^2.6.2",
     "tslint": "^5.11.0",
+    "typedoc": "^0.12.0",
     "typescript": "^3.0.3"
   },
   "peerDependencies": {
@@ -30,7 +31,8 @@
     "clean": "npm run clean-dist && npm run clean-tests",
     "clean-dist": "rimraf dist/**",
     "clean-tests": "rimraf tests/bin/**",
-    "lint": "./node_modules/.bin/tslint src/**/*.ts tests/**/*.ts -t verbose"
+    "lint": "./node_modules/.bin/tslint src/**/*.ts tests/**/*.ts -t verbose",
+    "generate-docs": "rimraf docs/** && typedoc --out ./docs --listInvalidSymbolLinks"
   },
   "author": "Konrad Powązka",
   "license": "MIT"