Add first version of auto-generated docs

JoinColony · Aug 13, 2020 · c4ff81c · c4ff81c
1 parent c6650f1
commit c4ff81c
Show file tree

Hide file tree

Showing 5 changed files with 115 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 <div align="center">
-  <img src="purser_color.svg" width="600" />
+  <img src="media/purser_color.svg" width="600" />
 </div>
 
 ## Purser

diff --git a/purser_color.svg → media/purser_color.svg b/purser_color.svg → media/purser_color.svg
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -34,6 +34,7 @@
   ],
   "devDependencies": {
     "@colony/eslint-config-colony": "8.0.1",
+    "@strictsoftware/typedoc-plugin-monorepo": "^0.3.1",
     "@types/bn.js": "^4.11.6",
     "@types/jest": "^25.2.1",
     "@typescript-eslint/eslint-plugin": "^2.29.0",
@@ -60,6 +61,7 @@
     "prettier": "2.0.5",
     "rimraf": "^3.0.2",
     "ts-jest": "^25.3.1",
+    "typedoc": "^0.17.0-3",
     "typescript": "^3.8.3"
   },
   "dependencies": {}

diff --git a/typedoc.json b/typedoc.json
@@ -0,0 +1,8 @@
+{
+  "name": "purser",
+  "readme": "README.md",
+  "out": "docs",
+  "mode": "library",
+  "external-modulemap": ".*packages\/(@purser\/[^\/]+)\/.*",
+  "media": "./media"
+}