Skip to content

Commit d74aa6f

Browse files
committed
📝 Generate docs api references to be compatible with github wiki
1 parent f5ba39d commit d74aa6f

13 files changed

+363
-354
lines changed

package.json

+3-2
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@
2525
"prepare": "yarn build",
2626
"release:yalc": "yarn prepare && lerna exec -- yalc push --no-scripts",
2727
"circular-modules": "lerna exec -- madge --circular src",
28-
"docs:compile": "lerna exec --scope=@ackee/antonio-core -- typedoc --out docs-api ./src/index.ts --plugin typedoc-plugin-markdown",
29-
"docs:commit": "git add ./packages/@ackee/antonio-core/docs-api && git commit -m ':memo: Update API references'"
28+
"docs:build": "lerna exec --scope=@ackee/antonio-core -- typedoc --options ./typedocsOptions.js",
29+
"docs:commit": "git add ./packages/@ackee/antonio-core/docs/api && git commit -m ':memo: Update docs - API references'"
3030
},
3131
"devDependencies": {
3232
"@ackee/browserslist-config": "^1.0.1",
@@ -60,6 +60,7 @@
6060
"prettier-config-ackee": "0.x",
6161
"ts-jest": "^27.0.2",
6262
"typedoc": "^0.21.0",
63+
"typedoc-github-wiki-theme": "^0.4.1",
6364
"typedoc-plugin-markdown": "^3.10.0",
6465
"typescript": "4.x"
6566
},

packages/@ackee/antonio-core/docs-api/classes/antonio.md

-238
This file was deleted.

0 commit comments

Comments
 (0)