up readme #15
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: | |
| # Runs on pushes targeting the `main` branch. Change this to `master` if you're | |
| # using the `master` branch as the default branch. | |
| push: | |
| branches: [master] | |
| pull_request: | |
| branches: [master] | |
| types: [opened, synchronize, reopened] | |
| # 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: | |
| actions: write # useful to delete gh cache | |
| 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@v4 | |
| with: | |
| fetch-depth: 0 # Not needed if lastUpdated is not enabled | |
| # - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm | |
| # - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun | |
| - name: Setup Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20 | |
| cache: npm # or pnpm / yarn | |
| cache-dependency-path: 'package-lock.json' # this should be a package-lock.json file | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v4 | |
| - name: Install dependencies | |
| run: npm ci # or pnpm install / yarn install / bun install | |
| - name: Julia version | |
| uses: julia-actions/setup-julia@v1 | |
| - name: Julia cache | |
| uses: julia-actions/cache@v1 | |
| - name: Install documentation dependencies | |
| run: julia --project=docs -e 'using Pkg; pkg"dev ."; Pkg.instantiate(); Pkg.precompile(); Pkg.status()' | |
| - name: generating examples md files | |
| run: | | |
| julia --project=docs/ --color=yes docs/make.jl | |
| - name: Build with VitePress | |
| run: | | |
| NODE_OPTIONS=--max-old-space-size=32768 npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build | |
| touch docs/docs_site/.vitepress/dist/.nojekyll | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: docs/docs_site/.vitepress/dist | |
| # Deployment job | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| needs: build | |
| runs-on: ubuntu-latest | |
| name: Deploy | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |