Merge pull request #5 from algorandfoundation/feature/typescript-docs

Feature/typescript docs
algorandfoundation · Mar 14, 2023 · 750daab · 750daab
2 parents 43b319c + 4731af6
commit 750daab
Show file tree

Hide file tree

Showing 3 changed files with 199 additions and 1 deletion.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -24,7 +24,8 @@
     "audit": "npm audit",
     "format": "prettier --write .",
     "commit-lint": "commitlint --edit -o",
-    "semantic-release": "semantic-release"
+    "semantic-release": "semantic-release",
+    "generate:code-docs": "typedoc"
   },
   "dependencies": {
     "algosdk": "^2.1.0",
@@ -48,6 +49,8 @@
     "tiny-invariant": "^1.3.1",
     "ts-jest": "^29.0.3",
     "ts-node": "^10.9.1",
+    "typedoc": "^0.23.26",
+    "typedoc-plugin-markdown": "^3.14.0",
     "typescript": "^4.9.3",
     "uuid": "^9.0.0"
   },

diff --git a/typedoc.json b/typedoc.json
@@ -0,0 +1,11 @@
+{
+  "entryPoints": ["src/"],
+  "entryPointStrategy": "expand",
+  "out": "docs/code",
+  "plugin": ["typedoc-plugin-markdown"],
+  "theme": "default",
+  "cleanOutputDir": true,
+  "githubPages": false,
+  "readme": "none",
+  "entryDocument": "README.md"
+}