A comprehensive toolkit, agent skills, templates, and automation workflows for developing, validating, and deploying custom Zendesk Guide Help Center themes.
- Python 3.8+
- Node.js 18+ (for
@zendesk/zclipreviewing)
-
Validate a theme:
python3 zendesk-help-center-themes/scripts/validate_theme.py zendesk-help-center-themes/assets/starter-theme
-
Preview locally with Zendesk CLI:
npx @zendesk/zcli themes:preview zendesk-help-center-themes/assets/starter-theme
-
Deploy to Zendesk Guide:
python3 zendesk-help-center-themes/scripts/deploy_theme.py zendesk-help-center-themes/assets/starter-theme \ --subdomain YOUR_SUBDOMAIN \ --email YOUR_EMAIL \ --token YOUR_API_TOKEN
- Automation: Python 3 (standard library)
- Themes & Templating: Curlybars (Zendesk Handlebars dialect), HTML5, CSS3, JavaScript (ES6+)
- Platform: Zendesk Guide / Help Center (API v2)
- CLI & Tooling:
@zendesk/zcli
.
├── .editorconfig # Code style & formatting rules
├── .gitignore # Ignore rules
├── AGENTS.md # AI coding agent briefing packet
├── CHANGELOG.md # Release history (Keep a Changelog)
├── CLAUDE.md # Pointer to AGENTS.md
├── CODE_OF_CONDUCT.md # Community code of conduct
├── CONTRIBUTING.md # Contribution guide
├── GEMINI.md # Pointer to AGENTS.md
├── LICENSE # MIT License
├── README.md # Human-facing overview & quickstart
├── REPORTING.md # Issue reporting guidelines
├── SECURITY.md # Public security policy & disclosure
├── docs/ # Canonical project documentation
│ ├── ARCHITECTURE.md # System architecture & layers
│ ├── DECISIONS.md # Architecture decision log (ADR)
│ ├── PRODUCT.md # Product scope & goals
│ ├── SECURITY.md # Technical threat model & hard rules
│ └── TESTING.md # Testing & validation strategy
└── zendesk-help-center-themes/ # Zendesk Help Center Themes skill
├── SKILL.md # Skill definition & guidelines
├── assets/starter-theme/ # Production-ready starter theme
├── references/ # Curlybars, manifest, and template docs
└── scripts/ # Validation and deployment scripts
For technical details, project guidelines, and development context:
- 🤖 For AI Coding Agents: Refer to AGENTS.md for development commands, project conventions, and agent instructions.
- 🏗️ Architecture: See docs/ARCHITECTURE.md for the system structure, major components, and workflows.
- ⚖️ Decision Log: See docs/DECISIONS.md for architectural decisions, rationale, and established conventions.
- 🎯 Product Scope: See docs/PRODUCT.md for product goals, supported features, and planned work.
- 🛡️ Security Guidelines: See docs/SECURITY.md for security practices and configuration guidance.
- 🧪 Testing Strategy: See docs/TESTING.md for test coverage, commands, and verification procedures.
Found a bug or have a feature request?
- Read the Issue Reporting Guide before submitting an issue.
- Please report issues via the GitHub Issue Tracker.
Contributions are welcome! Read the Contribution Guide for development setup, contribution conventions, and the pull request process.
If Zendesk Skills is useful to you:
- ⭐ Star this repository to help others discover the project.
- 📣 Spread the word by sharing it with your network.
- ☕ Support Our Work — Donate to help us maintain and grow our open-source projects.
This project is licensed under the MIT License.