mkdocs-github-pages-deployment

What problem does it solve?

This Skill guides teams through reliably deploying MkDocs documentation to GitHub Pages using GitHub Actions, while addressing common Markdown rendering issues to ensure your docs render correctly for public viewing.

Core Features & Use Cases

• Workflow configuration guidance: Set up a modern CI/CD flow that builds MkDocs and deploys to GitHub Pages.
• Markdown troubleshooting: Resolve indentation, footnotes, and grid table issues that break rendering.
• Operational scenarios: Use for new docs projects or to fix existing repos with stale or broken GitHub Pages deployments.

Quick Start

• Create a GitHub Actions workflow that runs mkdocs build and deploys the generated site to GitHub Pages.
• Ensure MkDocs extensions (grid tables, footnotes, etc.) are installed in the workflow environment.
• Verify the Pages URL in the Actions log and in the repository Settings.