docs: overview #5
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: Build and Deploy | |
| on: | |
| push: | |
| branches: | |
| - main # Set a branch name to trigger deployment | |
| pull_request: | |
| branches: | |
| - main # Set a branch name to trigger deployment | |
| jobs: | |
| build-and-deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout 🛎️ | |
| uses: actions/checkout@v4 | |
| - name: Install and Build 🔧 | |
| working-directory: docs | |
| run: | | |
| npm add -D vitepress | |
| npm install | |
| npm run docs:build # Replace with the command for your project. | |
| - name: Deploy 🚀 | |
| uses: JamesIves/github-pages-deploy-action@4.1.5 | |
| with: | |
| branch: gh-pages # The branch the action should deploy to. | |
| folder: docs/.vitepress/dist # The folder the action should deploy. | |
| commit-message: Deploy updates # The commit message for the deployment commit. If omitted, a default message will be used. |