CI Dokumentor

📢 CI Dokumentor is an automated documentation generator for CI/CD components

📖 Documentation

Complete documentation is available at: hoverkraft-tech.github.io/ci-dokumentor

Quick Links

• 🚀 Getting Started - Installation and quick start
• 🐳 Docker - Docker integration guide
• 🔧 GitHub Action - GitHub Actions integration
• 👨‍💻 Contributing - How to contribute

Examples

Integration examples for various usages and CI/CD platforms.

Npm package

# Install globally
npm install -g @ci-dokumentor/cli

# Use the CLI
ci-dokumentor generate --source action.yml

# Or use directly with npx
npx @ci-dokumentor/cli generate --source action.yml

Docker

CI Dokumentor is available as a Docker image that provides a lightweight, containerized way to generate documentation for your CI/CD components.

# Show available options
docker run --rm ghcr.io/hoverkraft-tech/ci-dokumentor/cli:latest --help

# Generate documentation from CI/CD file
docker run --rm -v $(pwd):/workspace -u $(id -u):$(id -g) ghcr.io/hoverkraft-tech/ci-dokumentor/cli:latest generate --source /workspace/action.yml

📖 Full Documentation: See our Docker documentation for complete Docker usage guide, troubleshooting, and advanced configurations.

GitHub Actions

- name: Generate CI Documentation
  uses: hoverkraft-tech/ci-dokumentor@c46a1a108957237cf485103a80b060c35c7dba33 # 0.2.2
  with:
    source: "action.yml"

📖 Full Documentation: For more details on GitHub Actions integration, see our GitHub Action documentation.

GitLab CI

generate-docs:
  stage: docs
  image: ghcr.io/hoverkraft-tech/ci-dokumentor/cli:latest
  script:
    - ci-dokumentor generate --source templates/my-component/template.yml
  artifacts:
    paths:
      - templates/my-component/docs.md

📖 Full Documentation: For more details on GitLab CI integration, see our GitLab CI documentation.

Dagger.io

func (m *MyModule) GenerateDocs(ctx context.Context, source *dagger.Directory) *dagger.Directory {
    return dag.Container().
  From("ghcr.io/hoverkraft-tech/ci-dokumentor/cli:latest").
        WithMountedDirectory("/workspace", source).
        WithWorkdir("/workspace").
        WithExec([]string{"ci-dokumentor", "generate", "--source", "action.yml"}).
        Directory("docs")
}

📖 Full Documentation: For more details on Dagger.io integration, see our Dagger.io documentation.

Contributing

Contributions are welcome! Please see the contributing guidelines for more details.

Author

👤 Hoverkraft

• Site: https://hoverkraft.cloud
• GitHub: @hoverkraft-tech

License

This project is licensed under the MIT License.

SPDX-License-Identifier: MIT

Copyright © 2025 hoverkraft

For more details, see the license.

---

This documentation was automatically generated by CI Dokumentor.