chore: setup typedoc configuration

everhardt · Jun 28, 2020 · 0506580 · 0506580
1 parent 921563b
commit 0506580
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -12,3 +12,4 @@ test/unit/perf-buffer.coffee
 
 src-coffee/
 test-coffee/
+docs/
diff --git a/package.json b/package.json
@@ -86,6 +86,7 @@
     "typescript": "^3.8.3"
   },
   "scripts": {
+    "docs": "typedoc",
     "lint": "eslint src test --ext .js,.ts && tsc",
     "test": "mocha test/unit test/unit/token test/unit/tracking-buffer",
     "test-integration": "mocha test/integration/",

diff --git a/tsconfig.json b/tsconfig.json
@@ -14,5 +14,13 @@
   "include": [
     "src/**/*.ts",
     "test/**/*.ts",
-  ]
+  ],
+
+  "typedocOptions": {
+    "name": "Tedious",
+    "mode": "library",
+    "out": "./docs",
+    "exclude": "**/node_modules/**",
+    "inputFiles": ["./src/tedious.ts"]
+  }
 }
Original file line number	Diff line number	Diff line change
Expand Up		@@ -12,3 +12,4 @@ test/unit/perf-buffer.coffee

		src-coffee/
		test-coffee/
		docs/