docs: add live demo link to README #3
This file contains hidden or 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: Deploy Docusaurus to GitHub Pages | |
| on: | |
| push: | |
| branches: | |
| - main | |
| permissions: | |
| contents: write | |
| jobs: | |
| deploy: | |
| name: Deploy to GitHub Pages | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Set up Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20 | |
| cache: 'npm' | |
| - name: Install root dependencies | |
| run: npm install | |
| - name: Install example dependencies | |
| run: npm install | |
| working-directory: ./example | |
| - name: Build Docusaurus site | |
| run: npm run build | |
| working-directory: ./example | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./example/build | |
| # The following lines are needed if you are deploying to a repository that is not the same as the one where the workflow is running. | |
| # For example, if you are deploying to a user page repository from an organization repository. | |
| # user_name: 'github-actions[bot]' | |
| # user_email: 'github-actions[bot]@users.noreply.github.com' |