chore(docs): update installation notes and add alternatives #35
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: Docs | |
| # Trigger this Action when content in the docs directory is modified | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - dev | |
| paths: | |
| - ".github/workflows/docs.yml" | |
| - "docs/**" | |
| # We need some permissions to publish to Github Pages | |
| permissions: | |
| contents: write | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: docs | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| env: | |
| DOTNET_LAUNCH_PROFILE: "none" | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - name: Setup .NET | |
| uses: actions/setup-dotnet@v4 | |
| with: | |
| global-json-file: ./global.json | |
| - name: Cache Perla packages | |
| uses: actions/cache@v4 | |
| with: | |
| path: /home/runner/.config/perla/packages/ | |
| key: ${{ runner.os }}-perla-packages-${{ hashFiles('docs/perla.json.importmap') }} | |
| restore-keys: | | |
| ${{ runner.os }}-perla-packages- | |
| - name: Restore tools | |
| run: dotnet tool restore | |
| - name: Build code | |
| run: dotnet build src/Perla -c Release | |
| - name: Install Dependencies | |
| run: cd docs && dotnet run --project ../src/Perla -c Release -f net10.0 --no-build --no-restore --no-launch-profile -- restore | |
| - name: Generate the documentation | |
| run: cd docs && dotnet run --project ../src/Perla -c Release -f net10.0 --no-build --no-restore --no-launch-profile -- build | |
| - name: Upload documentation | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: ./docs/dist | |
| # GitHub Actions recommends deploying in a separate job. | |
| deploy: | |
| runs-on: ubuntu-latest | |
| needs: build | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |