Fix grammar in README.md (#357) #378
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: docs | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - packages/**/src/*.{ts,js} | |
| - "**/README.md" | |
| - .github/workflows/docs.yml | |
| pull_request: | |
| paths: | |
| - packages/**/src/*.{ts,js} | |
| - "**/README.md" | |
| - .github/workflows/docs.yml | |
| jobs: | |
| gh-pages: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: "20" | |
| cache: "yarn" | |
| - name: Install dependencies | |
| run: yarn | |
| - name: Build libraries | |
| run: yarn build | |
| - name: Generate doc website | |
| run: yarn docs | |
| - if: github.event_name == 'push' && github.ref == 'refs/heads/main' | |
| name: Publish on Github Pages | |
| uses: crazy-max/[email protected] | |
| with: | |
| build_dir: docs | |
| jekyll: false | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |