Skip to main content
Version: Next

Docusaurus Operations Workflow

View Source

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โ€‹

InputTypeDefaultDescription
operationstring'build'Operation (build, deploy, version)
docs_pathstring'docs'Path to documentation directory
node_versionstring'22'Node.js version
version_namestring''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'