Setup JSDoc

src/cryptometrics/.gitignore

@@ -32,3 +32,6 @@ yarn-error.log*
 
 # vercel
 .vercel
+
+# parcel
+.parcel-cache

src/cryptometrics/jsdoc.json

+{
+  "tags": {
+    "allowUnknownTags": true
+  },
+  "source": {
+    "include": ["components", "pages"]
+  },
+  "plugins": ["plugins/markdown", "better-docs/component"],
+  "opts": {
+    "encoding": "utf8",
+    "destination": "docs/",
+    "recurse": true,
+    "verbose": true,
+    "template": "./node_modules/better-docs"
+  },
+  "templates": {
+    "better-docs": {
+      "name": "CryptoMetrics"
+    }
+  }
+}

src/cryptometrics/package.json

@@ -5,7 +5,8 @@
     "dev": "next dev",
     "build": "next build",
     "start": "next start",
-    "lint": "next lint"
+    "lint": "next lint",
+    "docs": "jsdoc -c ./jsdoc.json"
   },
   "dependencies": {
     "@heroicons/react": "^1.0.5",
@@ -27,8 +28,11 @@
   },
   "devDependencies": {
     "autoprefixer": "^10.4.2",
+    "better-docs": "2.4.1",
     "eslint": "8.9.0",
     "eslint-config-next": "12.1.0",
+    "jsdoc": "^3.6.10",
+    "parcel": "^2.3.2",
     "postcss": "^8.4.6",
     "tailwindcss": "^3.0.23"
   }