From configure-plugin
Checks and configures GitHub Pages deployment for docs sites, detects generators like MkDocs/TypeDoc/Docusaurus/Sphinx/rustdoc, audits workflows, migrates to actions/deploy-pages.
npx claudepluginhub laurigates/claude-plugins --plugin configure-pluginThis skill is limited to using the following tools:
Check and configure GitHub Pages deployment.
Generates design tokens/docs from CSS/Tailwind/styled-components codebases, audits visual consistency across 10 dimensions, detects AI slop in UI.
Records polished WebM UI demo videos of web apps using Playwright with cursor overlay, natural pacing, and three-phase scripting. Activates for demo, walkthrough, screen recording, or tutorial requests.
Delivers idiomatic Kotlin patterns for null safety, immutability, sealed classes, coroutines, Flows, extensions, DSL builders, and Gradle DSL. Use when writing, reviewing, refactoring, or designing Kotlin code.
Check and configure GitHub Pages deployment.
| Use this skill when... | Use another approach when... |
|---|---|
| Setting up GitHub Pages deployment for a documentation site | Configuring documentation standards or generators (/configure:docs instead) |
| Creating or updating a GitHub Actions workflow for Pages deployment | Debugging a failed GitHub Actions workflow (/configure:workflows instead) |
Migrating from peaceiris/actions-gh-pages to official actions/deploy-pages | Editing documentation content or markdown files |
| Auditing Pages workflow for outdated action versions or missing permissions | Setting up a custom domain via DNS (manual repository settings) |
| Adding Pages deployment to a project with an existing doc generator | Configuring CI/CD workflows unrelated to documentation |
find .github/workflows -maxdepth 1 \( -name '*doc*.yml' -o -name '*pages*.yml' \)find . -maxdepth 1 \( -name 'mkdocs.yml' -o -name 'typedoc.json' -o -name 'docusaurus.config.*' \)find . -maxdepth 1 -type d \( -name 'docs' -o -name 'site' \)find . -maxdepth 1 -name 'CNAME'find . -maxdepth 1 -name '.project-standards.yaml'Parse from command arguments:
--check-only: Report compliance status without modifications (CI/CD mode)--fix: Apply fixes automatically without prompting--source <docs|site|custom>: Override source directory detectionExecute this GitHub Pages deployment configuration check:
Identify existing documentation configuration:
| Config File | Generator | Output Directory |
|---|---|---|
typedoc.json | TypeDoc | docs/ or configured |
mkdocs.yml | MkDocs | site/ |
docs/conf.py | Sphinx | docs/_build/html/ |
docusaurus.config.js | Docusaurus | build/ |
Cargo.toml (with rustdoc) | rustdoc | target/doc/ |
| None | Static | docs/ |
If no documentation configured, report:
No documentation generator detected.
Consider running /configure:docs first to:
- Set up documentation linting standards
- Configure a documentation generator
Would you like to:
[A] Configure documentation first (/configure:docs)
[B] Set up static HTML hosting for existing docs/ directory
[C] Skip - I'll configure docs later
Check for existing GitHub Pages workflows by searching for:
actions/deploy-pagesactions/upload-pages-artifactpeaceiris/actions-gh-pagesExtract from existing workflow: current action versions, permissions, build steps, source directory.
Validate GitHub Actions workflow against standards:
| Check | Standard | Severity |
|---|---|---|
actions/deploy-pages | v4+ | WARN if older |
actions/configure-pages | v5+ | WARN if missing |
actions/upload-pages-artifact | v3+ | WARN if older |
| Permissions | pages: write, id-token: write | FAIL if missing |
| Environment | github-pages | WARN if missing |
| Concurrency | Group defined | INFO |
Print a formatted compliance report:
GitHub Pages Compliance Report
==============================
Project: [name]
Documentation Status:
Generator [typedoc|mkdocs|sphinx|rustdoc|static|not configured]
Source directory [docs/|site/|custom]
Build command [detected command or "not configured"]
GitHub Pages Workflow:
Workflow file .github/workflows/docs.yml [EXISTS | MISSING]
Workflow Checks (if exists):
deploy-pages v4 [PASS | OUTDATED | MISSING]
configure-pages v5 [PASS | MISSING]
upload-artifact v3 [PASS | OUTDATED]
Permissions pages: write, id-token [PASS | MISSING]
Environment github-pages [PASS | MISSING]
Overall: [X issues found]
Recommendations:
[List specific fixes needed]
If --check-only, stop here.
Create .github/workflows/docs.yml based on detected generator. Use the appropriate workflow template from REFERENCE.md:
./docs./site./docs/_build/html./target/doc./docs directoryAll workflows include:
pages: write, id-token: write)workflow_dispatch for manual triggersUpdate .project-standards.yaml:
standards_version: "2025.1"
last_configured: "[timestamp]"
components:
github-pages: "2025.1"
github-pages-generator: "[typedoc|mkdocs|sphinx|rustdoc|static]"
github-pages-source: "[docs/|site/|custom]"
GitHub Pages Configuration Complete
===================================
Workflow created: .github/workflows/docs.yml
Next Steps:
1. Enable GitHub Pages in repository settings:
Settings -> Pages -> Source: GitHub Actions
2. Push to main branch to trigger deployment:
git add .github/workflows/docs.yml
git commit -m "ci(docs): add GitHub Pages deployment workflow"
git push
3. After deployment, your docs will be available at:
https://OWNER.github.io/REPO/
Optional:
- Add custom domain: Create CNAME file with your domain
- Protect deployment: Configure environment protection rules
For detailed workflow templates, see REFERENCE.md.
Provide:
| Context | Command |
|---|---|
| Quick compliance check | /configure:github-pages --check-only |
| Auto-fix all issues | /configure:github-pages --fix |
| Check Pages workflow exists | find .github/workflows -name '*pages*' -o -name '*doc*' 2>/dev/null |
| Check Pages action versions | `grep -E 'deploy-pages |
| Verify Pages enabled | gh api repos/{owner}/{repo}/pages --jq '.status' |
| Check deployment status | gh api repos/{owner}/{repo}/pages/builds --jq '.[0].status' |
/configure:docs - Set up documentation standards and generators/configure:workflows - GitHub Actions workflow standards/configure:all - Run all compliance checks/configure:status - Quick compliance overview