aiskillstore/marketplace / skills/92bilal26/docusaurus-deployer
docusaurus-deployer
VerifiedThis skill should be used when deploying a Docusaurus site to GitHub Pages. It automates the configuration, building, and deployment process, handling GitHub Pages setup, environment configuration, and CI/CD automation. Includes local validation before GitHub Actions triggering.
Docusaurus GitHub Pages Deployer
Automate building and deploying Docusaurus documentation sites to GitHub Pages with local validation before CI/CD triggering.
Constitution Alignment: This skill implements production deployment standards defined in Constitution v4.0.1 (Pillar 9: Universal Cloud-Native Deployment from Section I). All deployments must meet project quality gates before publication.
What This Skill Does
- Project Analysis - Examine Docusaurus structure and dependencies
- Local Configuration Validation - Verify Docusaurus config and sidebars
- Local Build & Testing - Build site locally and validate output
- Content Verification - Check for broken links and syntax errors
- GitHub Pages Setup - Configure repository and deployment settings
- CI/CD Automation - Set up GitHub Actions workflows
- Deployment Verification - Validate successful deployment
When to Use This Skill
Deploy Docusaurus to GitHub Pages when:
- Setting up documentation deployment for the first time
- Making updates to documentation before publishing
- Updating deployment configuration
- Troubleshooting deployment issues
- Managing multiple documentation sites
- Ensuring documentation quality before production
How to Use This Skill
Follow the validate-locally-then-publish workflow:
Step 1: Prepare Repository Configuration
Gather GitHub organization/username, repository name, deployment target (user/project pages), and custom domain (optional).
Step 2: Analyze Project Structure
Examine Docusaurus project:
ls -la path_to_docusaurus_project/
cat path_to_docusaurus_project/docusaurus.config.ts
cat path_to_docusaurus_project/sidebars.ts
Verify docusaurus.config.ts, sidebars.js/ts, package.json engines field, and dependencies exist.
For detailed configuration guidance, see references/configuration-guide.md.
Step 3: Update Docusaurus Configuration
Update docusaurus.config.ts with GitHub Pages settings. See references/configuration-guide.md for complete configuration examples and guidelines based on deployment target (user vs. project pages).
Step 4: Build and Validate Locally
Install dependencies, run type checking, build site, validate output, test locally, and verify content quality.
Execute:
npm ci
npm run typecheck
npm run build
npm run serve
For detailed validation procedures, see references/local-validation-guide.md.
Step 5: Commit and Push to Main
After successful local validation:
git add .
git commit -m "Update documentation: [description]"
git push origin main
This triggers the GitHub Actions workflow.
Step 6: Set Up GitHub Actions
Create .github/workflows/deploy.yml using the template in references/deploy-workflow.yml.
For detailed workflow configuration and troubleshooting, see references/github-actions-guide.md.
Step 7: Configure GitHub Pages in Repository Settings
- Go to Settings → Pages
- Set source to GitHub Actions (or deploy from
gh-pagesbranch) - Configure custom domain if needed
- Enable branch protection on main branch
Step 8: Verify Deployment
Check GitHub Actions workflow status in Actions tab, verify site loads at configured URL, and confirm all navigation works.
Troubleshooting
For common issues and solutions, see references/troubleshooting.md, which covers:
- Build failures and type errors
- 404 errors after deployment
- Broken links and GitHub Actions issues
- Performance problems and content quality
Bundled Resources
references/deploy-workflow.yml- GitHub Actions workflow templatereferences/configuration-guide.md- Detailed Docusaurus configurationreferences/local-validation-guide.md- Build and validation proceduresreferences/github-actions-guide.md- CI/CD setup and configurationreferences/troubleshooting.md- Common issues and solutionsreferences/performance-standards.md- Performance targets and best practices
Performance Targets
- Build time: < 30 seconds (typical)
- Page load: < 3 seconds
- Bundle size: Optimized for documentation
- Accessibility: WCAG 2.1 AA compliance
Quality Gates (Constitution v3.1.2)
Before deployment to production, verify:
- All content passes validation-auditor validation
- Local build completes without errors
- No broken links or missing resources
- TypeScript type checking passes
- Performance targets met
- Accessibility standards verified
- GitHub Actions workflow configured correctly
Reference: See .specify/memory/constitution.md deployment standards section for complete production deployment standards.
Tools Used
- Node.js/npm (v20+)
- Docusaurus CLI
- TypeScript
- GitHub Actions
- GitHub Pages
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| writing-skillsobra/superpowersUse when creating new skills, editing existing skills, or verifying skills work before deployment | Stars: 319k | Updated | Claude CodeCodex | Verified | Install |
| xlsxanthropics/skillsUse this skill any time a spreadsheet file is the primary input or output. This means any task where the user wants to: open, read, edit, or fix an existing .xlsx, .xlsm, .xltx, .csv, or .tsv file (e.g., adding columns, computing formulas, formatting, charting, cleaning messy data); create a new spreadsheet from scratch or from other data sources; or convert between tabular file formats. Trigger especially when the user references a spreadsheet file by name or path — even casually (like "the xlsx in my downloads") — and wants something done to it or produced from it. Also trigger for cleaning or restructuring messy tabular data files (malformed rows, misplaced headers, junk data) into proper spreadsheets. The deliverable must be a spreadsheet file. Do NOT trigger when the primary deliverable is a Word document, HTML report, standalone Python script, database pipeline, or Google Sheets API integration, even if tabular data is involved. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |
| shipping-and-launchaddyosmani/agent-skillsPrepares production launches. Use when preparing to deploy to production, or when asking what needs to be in place before shipping. Use when you need a pre-launch checklist, when setting up monitoring, when planning a staged rollout, or when you need a rollback strategy. | Stars: 118k | Updated | Claude CodeCodex | Verified | Install |
| childhoodthedotmack/claude-memBabysit a shipped release after merge, publication, or deployment. Verify published packages, production behavior, installed plugins, and late CI or user reports until the observation window is clean; use babysit for PR readiness before release. | Stars: 118k | Updated | Claude CodeCodex | Verified | Install |