Mkdocs Github Pages Deployment
CheckedHelps with GitHub, deployment as part of automating DevOps pipelines and CI/CD workflows workflows.
Install on your platform
Showing Claude Code. One command installs this skill into any of the agents below.
- 1
Run this in your project
terminal$ npx skills add securityronin/ronin-marketplace --skill mkdocs-github-pages-deployment -a claude-code Uses the open-source
skillsCLI and needs Node.js. Add-gto install it for your user instead of this project.
What we know about this skill
Publisher
securityronin
Taken from the source listing. We haven't verified who controls this account.
Install target
Live repository
Not pinned. Installing fetches whatever the repository holds at the time you run the command.
Automated safety checks
This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.
Declares what it does: passed
SKILL.md parses and declares a name and a description.
SKILL.md exists, its frontmatter parses, and it declares a name and a description.
No undeclared network calls: passed
Only contacts known or declared hosts: 127.0.0.1.
Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.
Hosts contacted
127.0.0.1localNo obfuscated payloads: passed
No encoded or obfuscated payloads.
No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.
No credential access: passed
Reads no keys, tokens, keychains or credential files.
Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.
No pipe-to-shell installers: passed
No pipe-to-shell or download-and-run installers.
No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.
Pinned to a commit: passed
Scanned securityronin/ronin-marketplace at a42812d0e0.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.
- Commit
- a42812d0e0
- Scanned
- 1 file, 1,333 lines
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.