Switch to typedoc

README.md

@@ -2,9 +2,9 @@
 
 A CLI and JS library to extrude tiles in tilesets to avoid "bleeding" issues where tiles are rendered with the wrong color at the edges of tiles.
 
-![demo](./doc-source/images/demo.png)
+![demo](./images/demo.png)
 
-![explanation](./doc-source/images/explanation.png)
+![explanation](./images/explanation.png)
 
 You can read more about the bleeding problem and solution [here](https://web.archive.org/web/20180411151113/http://rotorz.com/unity/tile-system/docs/edge-correction). The TLDR is that there are many ways this type of rendering artifact can occur, e.g. from pixels being incorrectly blended when the edge of a tile in a tilemap texture is rendered. This CLI app handles both tilesets with and without margin & spacing. Check out my [blog post series](https://medium.com/@michaelwesthadley/modular-game-worlds-in-phaser-3-tilemaps-1-958fc7e6bbd6) about building modular worlds with tilemaps for more information on using tilemaps and extruding tiles.
 
@@ -65,7 +65,7 @@ Options:
 
 A note on terminology, _spacing_ is the number of pixels between neighboring tiles, while _margin_ is the number of pixels between the edges of the image and the tiles. Or, more visually explained:
 
-![Margin and spacing](./doc-source/images/margin-and-spacing.png)
+![Margin and spacing](./images/margin-and-spacing.png)
 
 ### Usage as a Library
 

package.json

@@ -10,10 +10,9 @@
     "pretest": "pnpm run build",
     "test": "ts-node ./tests/index.ts",
     "demo": "http-server ./examples/phaser -c-1 -o",
-    "doc": "esdoc -c ./.esdoc.json",
-    "postdoc": "cp -r doc-source/ docs/",
-    "deploy:doc": "gh-pages --branch gh-pages --dist docs",
-    "predeploy:doc": "pnpm run doc",
+    "docs:build": "typedoc",
+    "docs:run": "pnpm run docs:build && http-server ./docs -c-1 -o",
+    "docs:deploy": "pnpm run docs:build && gh-pages --branch gh-pages --dist docs",
     "prettier": "prettier --write \"./{src,tests}/**/*.{js,ts}\""
   },
   "repository": {
@@ -42,15 +41,14 @@
   },
   "devDependencies": {
     "@types/node": "^22.12.0",
-    "esdoc": "^1.1.0",
-    "esdoc-node": "^1.0.5",
-    "esdoc-standard-plugin": "^1.0.0",
     "gh-pages": "^6.3.0",
     "http-server": "^14.1.1",
     "imagemin": "^9.0.0",
     "imagemin-pngquant": "^10.0.0",
     "prettier": "^3.4.2",
     "ts-node": "^10.9.2",
+    "typedoc": "^0.27.6",
+    "typedoc-material-theme": "^1.3.0",
     "typescript": "^5.7.3"
   }
 }

typedoc.json

@@ -0,0 +1,6 @@
+{
+  "tsconfig": "./tsconfig.json",
+  "readme": "./README.md",
+  "plugin": ["typedoc-material-theme"],
+  "themeColor": "#cb9820"
+}