diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index f7b58e06..e2a4928b 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -13,7 +13,7 @@ jobs: node-version: '16' - run: npm install - name: Create Pages - run: npm run jsdoc + run: npm run typedoc - uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.jsdoc.json b/.jsdoc.json deleted file mode 100644 index 61252e7f..00000000 --- a/.jsdoc.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "opts": { - "template": "node_modules/minami", - "destination": "docs/", - "encoding": "utf8", - "recurse": true - }, - "tags": { - "allowUnknownTags": true, - "dictionaries": ["jsdoc"] - }, - "plugins": ["plugins/markdown"], - "source": { - "include": ["lib", "README.md"], - "includePattern": ".js$" - }, - "templates": { - "cleverLinks": false, - "monospaceLinks": true - } -} diff --git a/package.json b/package.json index e8a298df..f0568136 100644 --- a/package.json +++ b/package.json @@ -15,7 +15,7 @@ "eslint": "eslint src test", "test": "mocha -r ts-node/register 'test/scripts/**/*.ts'", "test-cov": "nyc --reporter=lcovonly --reporter=text-summary npm test", - "jsdoc": "jsdoc --configure .jsdoc.json", + "typedoc": "typedoc --entryPointStrategy expand ./src", "prepublish": "npm run typescript" }, "repository": "hexojs/warehouse", @@ -51,13 +51,13 @@ "chai-as-promised": "^7.1.1", "eslint": "^8.18.0", "eslint-config-hexo": "^5.0.0", - "jsdoc": "^3.6.10", "lodash": "^4.17.21", - "minami": "^1.2.3", "mocha": "^10.0.0", "nyc": "^15.0.0", "sinon": "^14.0.0", "ts-node": "^10.8.1", + "typedoc": "^0.23.19", + "typedoc-plugin-rename-defaults": "^0.6.4", "typescript": "^4.7.4" }, "engines": { diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 00000000..6b9e454f --- /dev/null +++ b/typedoc.json @@ -0,0 +1,8 @@ +{ + "exclude": ["**/node_modules/**", "**/test/**"], + "excludeExternals": true, + "hideGenerator": true, + "name": "hexojs/warehouse", + "out": "docs", + "readme": "README.md" +} \ No newline at end of file