Integrations
Guides and documentation for integrations supported by the project.
Available Integrations
CI/CD Platform Integrations
- 🐙 GitHub Actions — Use CI Dokumentor as a GitHub Action for automated documentation generation in your workflows
- 🦊 GitLab CI — GitLab CI integration for components and pipelines (planned for future development)
- 🗡️ Dagger.io — Integration with Dagger modules and pipelines (planned for future development)
Installation and Usage Methods
- 🐳 Docker — Use the Docker image for containerized environments and maximum portability
- 📦 Node.js Package — Install and use as an npm package in your Node.js projects
Migration and Compatibility
- 🔄 Migration Guide — Migrate from other documentation tools like action-docs, auto-doc, and more
Getting Started
-
Choose your integration method based on your workflow:
- GitHub workflows → GitHub Actions integration
- Docker/containers → Docker integration
- Node.js projects → Node.js package
- Existing tools → Migration guide
-
Follow the specific setup guide for your chosen integration
-
Configure your first documentation generation using the examples provided
Quick Reference
| Integration | Best For | Status |
|---|---|---|
| GitHub Actions | GitHub workflows and repositories | ✅ Available |
| Docker | Cross-platform, CI/CD pipelines | ✅ Available |
| Node.js Package | Local development, npm scripts | ✅ Available |
| Migration Tool | Transitioning from other tools | ✅ Available |
| GitLab CI | GitLab repositories and pipelines | 🚧 Planned |
| Dagger.io | Dagger modules and pipelines | 🚧 Planned |
Need Help?
- 📖 See our CLI documentation for complete command reference
- 🏗️ Check the templates for ready-to-use documentation templates
- 🛠️ Review developer documentation if you're contributing or extending CI Dokumentor
- 🐛 Open an issue if you encounter problems