docs: Add using goose free guide (#482) #107
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
name: Deploy MkDocs | |
on: | |
push: | |
branches: | |
- main # Trigger deployment on pushes to main | |
paths: | |
- 'docs/**' | |
- 'mkdocs.yml' | |
- '.github/workflows/deploy_docs.yaml' | |
pull_request: | |
branches: | |
- main | |
paths: | |
- 'docs/**' | |
- 'mkdocs.yml' | |
- '.github/workflows/deploy_docs.yaml' | |
jobs: | |
deploy: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
- name: Install UV | |
uses: astral-sh/setup-uv@v3 | |
- name: Create UV virtual environment | |
run: uv venv | |
- name: Install dependencies | |
run: uv pip install "mkdocs-material[imaging]" Pillow cairosvg | |
- name: Build the documentation | |
run: uv run mkdocs gh-deploy --force |