chore: add typedoc

faker-js · Jan 11, 2022 · 4c627e6 · 4c627e6
1 parent 21c0c90
commit 4c627e6
Show file tree

Hide file tree

Showing 3 changed files with 131 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -72,6 +72,9 @@ versions.json
 # Dist
 /dist
 
+# TypeDoc
+/docs
+
 # Faker
 TAGS
 REVISION

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -13,6 +13,7 @@
     "browser": "./node_modules/.bin/gulp browser",
     "jsdoc": "./node_modules/.bin/gulp jsdoc",
     "build": "tsc",
+    "typedoc": "typedoc src/index.ts",
     "format": "prettier --write .",
     "lint": "node_modules/.bin/eslint ./lib/animal.js",
     "test": "node_modules/.bin/mocha test/*.*.js",
@@ -64,6 +65,7 @@
     "prettier": "2.5.1",
     "sinon": "^9.0.3",
     "through2": "2.0.0",
+    "typedoc": "^0.22.10",
     "typescript": "~4.5.4",
     "vinyl-buffer": "^1.0.1",
     "vinyl-source-stream": "^2.0.0",