feat: ✨ add compodoc

zhumeisongsong · Nov 18, 2024 · 9ad3134 · 9ad3134
1 parent 156abc4
commit 9ad3134
Show file tree

Hide file tree

Showing 4 changed files with 1,386 additions and 28 deletions.
diff --git a/.gitignore b/.gitignore
@@ -43,3 +43,5 @@ Thumbs.db
 
 .env
 .env.local
+
+documentation
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,6 +1,7 @@
 {
   "cSpell.words": [
+    "compodoc",
     "nestjs",
-    "supergraph",
+    "supergraph"
   ]
 }
diff --git a/package.json b/package.json
@@ -3,7 +3,8 @@
   "version": "0.0.0",
   "license": "MIT",
   "scripts": {
-    "commit": "git-cz"
+    "commit": "git-cz",
+    "compodoc":"pnpx @compodoc/compodoc -p tsconfig.base.json"
   },
   "release": {
     "branches": [
@@ -32,6 +33,7 @@
     "zod": "^3.23.8"
   },
   "devDependencies": {
+    "@compodoc/compodoc": "^1.1.26",
     "@eslint/js": "^9.14.0",
     "@nestjs/schematics": "^10.2.3",
     "@nestjs/testing": "^10.4.7",
Original file line number	Diff line number	Diff line change
Expand Up		@@ -43,3 +43,5 @@ Thumbs.db

		.env
		.env.local

		documentation