docusaurus-deployer

What problem does it solve?

Deploying Docusaurus documentation sites to GitHub Pages can involve intricate configuration, manual build steps, and complex CI/CD setup. This skill streamlines the entire process, automating configuration, local validation, and GitHub Actions workflows to ensure a smooth, error-free deployment.

Core Features & Use Cases

• Automated GitHub Pages Setup: Guides through configuring repository settings and Docusaurus docusaurus.config.ts for seamless deployment to user, organization, or project pages.
• CI/CD Automation with GitHub Actions: Provides a ready-to-use GitHub Actions workflow template (deploy-workflow.yml) to automate building, type checking, and deploying the Docusaurus site on every push to the main branch.
• Local Validation Workflow: Emphasizes a "validate-locally-then-publish" approach, including steps for installing dependencies, running type checks, building, and serving the site locally to catch errors before deployment.
• Use Case: A team needs to publish their project's documentation, built with Docusaurus, to GitHub Pages. This skill can walk them through setting up the docusaurus.config.ts, creating the GitHub Actions workflow, and performing local checks to ensure the documentation is always up-to-date and accessible.

Quick Start

Using the docusaurus-deployer skill, explain how to configure docusaurus.config.ts for a Docusaurus project deployed to GitHub Pages at https://username.github.io/my-repo/.