📝 Generate docs api references to be compatible with github wiki

AckeeCZ · Jun 19, 2021 · d74aa6f · d74aa6f
1 parent f5ba39d
commit d74aa6f
Show file tree

Hide file tree

Showing 13 changed files with 363 additions and 354 deletions.
diff --git a/package.json b/package.json
@@ -25,8 +25,8 @@
         "prepare": "yarn build",
         "release:yalc": "yarn prepare && lerna exec -- yalc push --no-scripts",
         "circular-modules": "lerna exec -- madge --circular src",
-        "docs:compile": "lerna exec --scope=@ackee/antonio-core -- typedoc --out docs-api ./src/index.ts --plugin typedoc-plugin-markdown",
-        "docs:commit": "git add ./packages/@ackee/antonio-core/docs-api && git commit -m ':memo: Update API references'"
+        "docs:build": "lerna exec --scope=@ackee/antonio-core -- typedoc --options ./typedocsOptions.js",
+        "docs:commit": "git add ./packages/@ackee/antonio-core/docs/api && git commit -m ':memo: Update docs - API references'"
     },
     "devDependencies": {
         "@ackee/browserslist-config": "^1.0.1",
@@ -60,6 +60,7 @@
         "prettier-config-ackee": "0.x",
         "ts-jest": "^27.0.2",
         "typedoc": "^0.21.0",
+        "typedoc-github-wiki-theme": "^0.4.1",
         "typedoc-plugin-markdown": "^3.10.0",
         "typescript": "4.x"
     },

diff --git a/packages/@ackee/antonio-core/docs-api/classes/antonio.md b/packages/@ackee/antonio-core/docs-api/classes/antonio.md