Skip to content

Commit

Permalink
Add MkDocs Material pages
Browse files Browse the repository at this point in the history
  • Loading branch information
vd-rd authored Jan 10, 2025
1 parent b34d2b8 commit 831e0e3
Showing 1 changed file with 50 additions and 0 deletions.
50 changes: 50 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 831e0e3

Please sign in to comment.