[Breaking] New syntax, plots backend, and features #1
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: Documenter | |
| on: | |
| # Runs on pushes targeting the `master` branch. Change this to `main` if you're | |
| # using the `main` branch as the default branch. | |
| push: | |
| branches: | |
| - main | |
| tags: ["*"] | |
| pull_request: | |
| # 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 | |
| contents: write | |
| pages: write | |
| id-token: write | |
| statuses: 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 | |
| - name: Setup Node # This is still useful because it caches the node_modules so we don't constantly re-install. You don't technically need this, though. | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: 20 | |
| cache: npm # or pnpm / yarn | |
| cache-dependency-path: "docs/package-lock.json" # this should be a package-lock.json file | |
| - name: Setup Julia | |
| uses: julia-actions/setup-julia@v1 | |
| - name: Pull Julia cache | |
| uses: julia-actions/cache@v1 | |
| - name: Install documentation dependencies | |
| # run: julia --project=docs -e 'using Pkg; Pkg.instantiate(); Pkg.update(); Pkg.precompile(); Pkg.status()' | |
| run: julia --project=docs -e 'using Pkg; pkg"dev ."; Pkg.instantiate(); Pkg.precompile(); Pkg.status()' | |
| - name: Instantiate NPM | |
| run: cd docs/; npm i; cd .. | |
| #- name: Creating new mds from src | |
| - name: Build and deploy docs | |
| uses: julia-actions/julia-docdeploy@v1 | |
| with: | |
| install-package: false | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token | |
| DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key | |
| GKSwstype: "100" # for Plots.jl plots (if you have them) | |
| JULIA_DEBUG: "Documenter" | |
| DATADEPS_ALWAYS_ACCEPT: true |