Comprehensive documentation for workflow-kit GitHub Actions workflows
Visit the documentation site: workflow-kit.github.io/docs
This documentation is built with MkDocs Material.
# Install dependencies pip install -r requirements.txt # Serve locally mkdocs serve # Access at http://localhost:8000
# Build static site mkdocs build # Output in site/ directory
- MkDocs β Static site generator
- Material for MkDocs β Theme
- Mermaid β Diagrams
- GitHub Pages β Hosting
docs/
βββ docs/ # Documentation source
β βββ index.md # Homepage
β βββ getting-started.md # Getting started guide
β βββ workflows/ # Workflow documentation
β β βββ pr-auto-labeler/ # PR Auto-Labeler workflow
β βββ assets/ # Images and static files
βββ mkdocs.yml # MkDocs configuration
βββ requirements.txt # Python dependencies
βββ Dockerfile # Docker build
βββ .github/workflows/ # GitHub Actions
βββ deploy-docs.yml # Auto-deploy to GitHub Pages
Documentation is automatically deployed to GitHub Pages when changes are pushed to main branch.
The deployment workflow:
- Installs dependencies
- Builds the MkDocs site
- Deploys to
gh-pagesbranch - GitHub Pages serves the site
- Fork the repository
- Create a feature branch
- Make your changes
- Test locally with
mkdocs serve - Submit a pull request
MIT License - see LICENSE for details.
Made with β€οΈ by the workflow-kit team