docs(readme): better intro #108
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
| # Sample workflow for building and deploying a VitePress site to GitHub Pages | |
| # | |
| name: Deploy VitePress site to Pages | |
| on: | |
| push: | |
| branches: [master] | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: false | |
| jobs: | |
| # Build job | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 # Not needed if lastUpdated is not enabled | |
| - name: Setup Node | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: 18 | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v3 | |
| - name: Install dependencies | |
| working-directory: docs/vitepress | |
| run: npm ci | |
| - name: Build with VitePress | |
| working-directory: docs/vitepress | |
| run: | | |
| npm run docs:build | |
| touch .vitepress/dist/.nojekyll | |
| mkdir -p .vitepress/dist/trame | |
| cp -rf .vitepress/dist/logos .vitepress/dist/trame/logos | |
| cp -rf .vitepress/dist/assets .vitepress/dist/trame/assets | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v2 | |
| with: | |
| path: docs/vitepress/.vitepress/dist | |
| # Deployment job | |
| deploy: | |
| needs: build | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| name: Deploy | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v2 |