docs: 📝 readme updated #22
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 Docs 📚 | |
| on: | |
| push: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout 🧳 | |
| uses: actions/checkout@v4 | |
| - name: Install Node.js 🔥 | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20 | |
| - name: Install pnpm 👀 | |
| uses: pnpm/action-setup@v3 | |
| id: pnpm-install | |
| with: | |
| version: 8 | |
| run_install: false | |
| - name: Get pnpm store directory 🏪 | |
| id: pnpm-cache | |
| shell: bash | |
| run: | | |
| echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT | |
| - name: Setup pnpm cache 💰 | |
| uses: actions/cache@v4 | |
| with: | |
| path: ${{ steps.pnpm-cache.outputs.STORE_PATH }} | |
| key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pnpm-store- | |
| - name: Install dependencies ⏬ | |
| run: pnpm install --no-frozen-lockfile | |
| - name: Build Docs ⏰ | |
| run: pnpm run build:docs | |
| - name: Upload Pages Artifact ☁️ | |
| uses: actions/upload-pages-artifact@v3 | |
| id: deployment | |
| with: | |
| path: ./docs # This should be your TypeDoc "out" path. | |
| deploy: | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| needs: build | |
| steps: | |
| - name: Deploy to GitHub Pages 🚀 | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |