setup-github-pages-deploy

You can automate deploying an MkDocs site to GitHub Pages by adding a GitHub Actions workflow that handles building and publishing without overwriting your existing CI/CD setups. This skill generates that ready-to-commit workflow file.

Yes, the GitHub Pages deployment workflow supports multiple package managers including uv and pip, alongside an auto-detection mode to accommodate different project environments and build preferences.

The best way to deploy MkDocs documentation without overwriting existing GitHub Actions workflows is to add an optional workflow file that handles publishing independently. This skill validates prerequisites and outputs a separate, ready-to-commit workflow file.

Yes, you can select between deployment strategies when deploying MkDocs by specifying either the GitHub Actions method or the traditional gh-pages branch method to match your repository's publishing configuration.

You need to ensure your repository meets the prerequisites for publishing. This skill handles configuring Pages settings and allows you to specify the branch, Python version, and site URL for the deployment workflow.

Yes, you can perform a dry-run to validate the deployment workflow generation process. This allows you to verify prerequisites and configuration choices before outputting the final ready-to-commit workflow file.