From 831e0e3e7415dc3790a289909c00f84946c42490 Mon Sep 17 00:00:00 2001 From: Vadim Radu Date: Fri, 10 Jan 2025 20:25:56 +0200 Subject: [PATCH] Add MkDocs Material pages --- .github/workflows/docs.yaml | 50 +++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 .github/workflows/docs.yaml diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml new file mode 100644 index 0000000..1498636 --- /dev/null +++ b/.github/workflows/docs.yaml @@ -0,0 +1,50 @@ +# Simple workflow for deploying static content to GitHub Pages +name: Github Pages Workflow + +on: + # Runs on pushes targeting the default branch + push: + branches: ["main"] + + # 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: + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + # Removed Git Credentials setup (Redundant) + - uses: actions/setup-python@v5 + with: + python-version: 3.x + - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV + - uses: actions/cache@v4 + with: + key: mkdocs-material-${{ env.cache_id }} + path: .cache + restore-keys: | + mkdocs-material- + - run: pip install mkdocs-material + - run: mkdocs build # Adjusted from 'mkdocs gh-deploy' + - uses: actions/configure-pages@v5 # Added + - uses: actions/upload-pages-artifact@v3 # Added + with: + path: 'site/' + - uses: actions/deploy-pages@v4 # Added + id: deployment