docs: bootstrap API docs generator 🕮

DrSensor · Jan 29, 2019 · 1a4198b · 1a4198b
1 parent c7df3be
commit 1a4198b
Show file tree

Hide file tree

Showing 4 changed files with 169 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -5,6 +5,7 @@
 /.nyc_output
 dist
 /coverage
+/docs
 /lib
 types
 /tmp

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -24,6 +24,7 @@
 		"jest": "^24.0.0",
 		"lerna": "^3.10.7",
 		"lint-staged": "^8.1.0",
+		"opn-cli": "^4.0.0",
 		"prettier": "^1.15.3",
 		"rollup": "^1.0.0",
 		"rollup-plugin-alias": "^1.5.1",
@@ -35,6 +36,7 @@
 		"shelljs": "^0.8.3",
 		"tslint": "^5.12.0",
 		"tslint-config-prettier": "^1.17.0",
+		"typedoc": "^0.14.2",
 		"typescript": "^3.2.2"
 	},
 	"license": "MIT",
@@ -68,7 +70,8 @@
 		"postpack": "rm -f oclif.manifest.json",
 		"posttest": "tslint -p . -t stylish",
 		"prepack": "npm run build",
-		"predocs": "echo 🙄",
+		"predocs": "typedoc packages/library/src",
+		"docs": "opn docs/index.html",
 		"prepublishOnly": "npm run build",
 		"release": "lerna version --no-push --no-git-tag-version --yes",
 		"release:ok": "lerna version",

diff --git a/typedoc.js b/typedoc.js
@@ -0,0 +1,7 @@
+module.exports = {
+	name: "⭘bot",
+	out: "docs",
+	target: "es6",
+	theme: "minimal",
+	mode: "file",
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,6 +5,7 @@ @@
     /.nyc_output
     dist
     /coverage
+    /docs
     /lib
     types
     /tmp
@@ Expand Down @@