Mkdocs Github Pages Deployment
Helps with GitHub, deployment as part of automating DevOps pipelines and CI/CD workflows workflows.
Install on your platform
We auto-selected Claude Code based on this skill’s supported platforms.
Run in terminal (recommended)
claude mcp add mkdocs-github-pages-deployment npx -- -y @trustedskills/mkdocs-github-pages-deployment
Or manually add to ~/.claude/settings.json
{
"mcpServers": {
"mkdocs-github-pages-deployment": {
"command": "npx",
"args": [
"-y",
"@trustedskills/mkdocs-github-pages-deployment"
]
}
}
}Requires Claude Code (claude CLI). Run claude --version to verify your install.
About This Skill
What it does
This skill automates the deployment of MkDocs documentation sites to GitHub Pages. It handles building the site and pushing the generated static files to a designated branch on your GitHub repository, effectively publishing your documentation online. This eliminates manual steps and ensures consistent deployments.
When to use it
- You've created a MkDocs project for documenting a software library or application.
- You want to automatically publish your MkDocs site whenever changes are made.
- You need a simple, automated way to keep your documentation up-to-date on GitHub Pages.
- Your team wants to streamline the documentation publishing process and reduce errors.
Key capabilities
- Automated build process for MkDocs projects.
- Deployment of static files to a specified branch on GitHub.
- Integration with GitHub Pages hosting.
Example prompts
- "Deploy my MkDocs site from the current directory to the
gh-pagesbranch." - "Publish the documentation in
/docsto GitHub Pages using the repositorymy-org/my-project." - “Build and deploy my mkdocs project.”
Tips & gotchas
- Ensure you have a GitHub personal access token with appropriate permissions (repo scope) configured for authentication.
- The skill requires MkDocs to be installed in your environment.
Tags
TrustedSkills Verification
Unlike other registries that point to live repositories, TrustedSkills pins every skill to a verified commit hash. This protects you from malicious updates — what you install today is exactly what was reviewed and verified.
Security Audits
| Gen Agent Trust Hub | Pass |
| Socket | Pass |
| Snyk | Pass |
🌐 Community
Passed automated security scans.