Usage: great-docs setup-github-pages [OPTIONS]
Set up automatic deployment to GitHub Pages.
This command creates a GitHub Actions workflow that automatically builds and
deploys your documentation when you push to the main branch.
The workflow will:
• Build docs on every push and pull request
• Deploy to GitHub Pages on main branch pushes
• Use Quarto's official GitHub Action for reliable builds
After running this command, commit the workflow file and enable GitHub Pages
in your repository settings (Settings → Pages → Source: GitHub Actions).
Examples:
great-docs setup-github-pages # Use defaults
great-docs setup-github-pages --main-branch dev # Deploy from 'dev' branch
great-docs setup-github-pages --python-version 3.12
great-docs setup-github-pages --force # Overwrite existing workflow
Options:
--project-path DIRECTORY Path to your project root directory (default:
current directory)
--main-branch TEXT Main branch name for deployment (default: main)
--python-version TEXT Python version for CI (default: 3.11)
--force Overwrite existing workflow file without prompting
--help Show this message and exit.