Add additional usage instructions and details to readme.md #6
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: JSDoc Action | |
| on: | |
| release: | |
| branches: [ "master" ] | |
| pull_request: | |
| types: [ closed ] | |
| branches: | |
| - master | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Build | |
| uses: andstor/jsdoc-action@v1 | |
| with: | |
| source_dir: ./lib | |
| recurse: true | |
| output_dir: ./docs | |
| config_file: jsdoc.json | |
| front_page: readme.md | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} | |
| publish_dir: ./docs |