Skip to content

Commit

Permalink
Merge pull request #19 from erikyo/docs
Browse files Browse the repository at this point in the history
Update jsdoc.json and jsDoc workflow for better config
  • Loading branch information
erikyo authored Dec 2, 2023
2 parents e6d4a39 + 41ef757 commit 40ee2e3
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 7 deletions.
13 changes: 9 additions & 4 deletions .github/workflows/jsDoc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,13 @@ jobs:
config_file: jsdoc.json
front_page: readme.md

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
- name: Setup Pages
uses: actions/configure-pages@v2
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./out
# Upload entire repository
path: '.'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
7 changes: 4 additions & 3 deletions jsdoc.json
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
{
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc"]
"dictionaries": ["jsdoc","closure"]
},
"typescript": {
"moduleRoot": "lib"
},
"sourceType": "module",
"source": {
"include": ["lib", "package.json", "readme.md"],
"include": ["./lib", "package.json", "readme.md"],
"includePattern": "\\.(jsx|js|ts|tsx)$",
"excludePattern": "(^|\\/|\\\\)_"
},
"opts": {
"encoding": "utf8",
"destination": "docs",
"destination": "./docs",
"readme": "./readme.md",
"recurse": true
},
Expand Down

0 comments on commit 40ee2e3

Please sign in to comment.