Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: jsdoc to typedoc #136

Merged
merged 1 commit into from
Oct 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
Expand Down
21 changes: 0 additions & 21 deletions .jsdoc.json

This file was deleted.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minami is theme for jsdoc. So, no need it if we migrate to typedoc.

"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",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"typescript": "^4.7.4"
},
"engines": {
Expand Down
8 changes: 8 additions & 0 deletions typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"exclude": ["**/node_modules/**", "**/test/**"],
"excludeExternals": true,
"hideGenerator": true,
"name": "hexojs/warehouse",
"out": "docs",
"readme": "README.md"
}