Merge pull request #19 from shubhvjain/18-documentation-website #1
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: Generate and Publish JSDoc | |
on: | |
push: | |
branches: | |
- main # Change this to the branch you want to use | |
jobs: | |
build: | |
name: Generate JSDoc and Publish to GitHub Pages | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v3 | |
- name: Set up Node.js | |
uses: actions/setup-node@v3 | |
with: | |
node-version: '18' # Specify your Node.js version | |
- name: Install dependencies | |
run: npm ci | |
- name: Generate JSDoc | |
run: npx jsdoc -c jsdoc.json | |
- name: Deploy to GitHub Pages | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./docs-static |