feat(docs): add api docs via typedoc

Signed-off-by: Griko Nibras <[email protected]>

Author: Griko Nibras

.gitignore

@@ -6,6 +6,7 @@
 .pnp.*
 .yarn/*
 dist/
+docs/
 package-lock.json
 yarn.lock
 

README.md

@@ -18,8 +18,6 @@ Toggle custom hook and component wrapper for React 🔦
   - [Toggle wrapper - `<ToggleWrap />`](#toggle-wrapper---togglewrap-)
   - [`<ClientOnly />`](#clientonly-)
 - [API](#api)
-  - [Toggle hook](#toggle-hook)
-  - [Toggle wrapper](#toggle-wrapper)
 - [Suggestions and/or questions](#suggestions-andor-questions)
 - [Maintainers](#maintainers)
 - [License](#license)
@@ -101,13 +99,7 @@ function App() {
 
 ## API
 
-### Toggle hook
-
-TODO
-
-### Toggle wrapper
-
-TODO
+Read the full API documentation on <https://use-toggle-api-docs.koding.ninja>.
 
 ## Suggestions and/or questions
 

package.json

@@ -22,10 +22,11 @@
   "scripts": {
     "# general commands": "##################################################",
     "build": "tsup",
+    "build:docs": "typedoc",
     "deduplicate": "npx yarn-deduplicate && yarn install",
     "dev": "tsup --watch src",
     "lint": "eslint --fix \"src/**/*.{js,jsx,ts,tsx}\"",
-    "prepare": "husky install $PWD/.husky",
+    "prepare": "husky install $PWD/.husky && yarn build",
     "prepublishOnly": "yarn lint",
     "ship": "np",
     "type-check": "tsc --noEmit",
@@ -43,6 +44,7 @@
     "react": "^17",
     "react-dom": "^17",
     "tsup": "^5",
+    "typedoc": "^0",
     "typescript": "^4"
   },
   "peerDependencies": {

tsconfig.json

@@ -16,5 +16,10 @@
     "strictNullChecks": true,
     "target": "es2017"
   },
-  "exclude": ["dist", "node_modules"]
+  "exclude": ["dist", "docs", "node_modules"],
+  "typedocOptions": {
+    "entryPoints": ["src/index.ts"],
+    "includeVersion": true,
+    "out": "docs"
+  }
 }