Docusaurus Operations Workflow
Build and deploy documentation using Docusaurus or other documentation frameworks.
Overviewโ
This workflow handles documentation building, versioning, and deployment operations for Docusaurus-based documentation sites.
When to Useโ
- โ You use Docusaurus for documentation
- โ You need automated documentation deployment
- โ You want documentation versioning
- โ You need to build documentation on CI
Inputsโ
| Input | Type | Default | Description |
|---|---|---|---|
operation | string | 'build' | Operation (build, deploy, version) |
docs_path | string | 'docs' | Path to documentation directory |
node_version | string | '22' | Node.js version |
version_name | string | '' | Version name for versioning |
Usage Examplesโ
Build Documentationโ
jobs:
docs:
uses: Chisanan232/GitHub-Action_Reusable_Workflows-Python/.github/workflows/rw_docusaurus_operations.yaml@master
with:
operation: build
docs_path: docs
Deploy to GitHub Pagesโ
jobs:
docs:
uses: Chisanan232/GitHub-Action_Reusable_Workflows-Python/.github/workflows/rw_docusaurus_operations.yaml@master
with:
operation: deploy
docs_path: docs
Version Documentationโ
jobs:
docs:
uses: Chisanan232/GitHub-Action_Reusable_Workflows-Python/.github/workflows/rw_docusaurus_operations.yaml@master
with:
operation: version
version_name: '1.0.0'
Related Workflowsโ
- rw_documentation_deployment - Deploy documentation
- Documentation Pipeline - Complete pipeline