gh-mkpage

Generate and deploy markdown documentation pages from GitHub using automated CI/CD. → Documentation

Features

• MkDocs + Material theme — modern docs site with search, navigation, code highlighting
• Mermaid diagram support — render flowcharts, sequence diagrams, and more inline
• GitHub Actions CI/CD — auto-builds on push to main, deploys to gh-pages
• PR previews — each PR gets a preview/pr-# folder on gh-pages, auto-cleaned on merge
• Agent skill ecosystem — 15+ installed skills for caveman comms, TDD, triage, code review, handoff, and more
• Demo enforcement — pre-commit hook requires a demo file for every new skill

Quick start

git clone https://github.com/mibracy/gh-mkpage.git
cd gh-mkpage
# Preview locally
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

Project structure

.agents/skills/     # Installed agent skills
.githooks/          # Pre-commit hook (skill-demo enforcement)
.github/workflows/  # CI/CD pipeline
docs/
  index.md          # Entry page
  skills/           # Skill demo files
  updates/          # Project progress logs
mkdocs.yml          # Docs site config
AGENTS.md           # Agent workspace instructions

Docs workflow

Trigger	Deployment
Push to main	Root of gh-pages
PR open / update	preview/pr-# on gh-pages
PR merged / closed	preview/pr-# removed

Requirements

• Docker (for local preview)
• GitHub repository with Pages enabled

License

MIT