https://github.com/rohankmr414/argodocs

Generate reference documentation for argo workflow templates
https://github.com/rohankmr414/argodocs

argo-workflows documentation go golang kubernetes

Last synced: 5 months ago
JSON representation

Generate reference documentation for argo workflow templates

• Host: GitHub
• URL: https://github.com/rohankmr414/argodocs
• Owner: rohankmr414
• License: mit
• Created: 2022-02-22T19:26:50.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-08-30T14:34:04.000Z (almost 3 years ago)
• Last Synced: 2024-06-20T05:26:19.035Z (about 2 years ago)
• Topics: argo-workflows, documentation, go, golang, kubernetes
• Language: Go
• Homepage:
• Size: 197 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# argodocs

[![Go Reference](https://pkg.go.dev/badge/pkg.go.dev/github.com/rohankmr414/argodocs.svg)](https://pkg.go.dev/github.com/rohankmr414/argodocs) [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/rohankmr414/argodocs)](https://github.com/rohankmr414/argodocs/releases/tag/latest) [![build](https://github.com/rohankmr414/argodocs/actions/workflows/build.yaml/badge.svg)](https://github.com/rohankmr414/argodocs/actions/workflows/build.yaml) [![License: MIT](https://img.shields.io/badge/License-MIT-black.svg)](https://opensource.org/licenses/MIT)

`argodocs` is a tool to generate reference documentation for argo workflow templates.

## Installation

```

go install github.com/rohankmr414/argodocs@latest

```

Add `$GOPATH/bin` to your `$PATH` or copy `$GOPATH/bin/argodocs` to your `$PATH`.

## Usage

```

Usage:

  argodocs [command]

Available Commands:

  generate    Generate docs from workflow manifest.

  help        Help about any command

Flags:

  -h, --help   help for argodocs

Use "argodocs [command] --help" for more information about a command.

```

## Generate

```

argodocs generate **/*.yaml --output-prefix=../docs/

```

## Contributing

If you're interested in contributing to argodocs, check out [CONTRIBUTING.md](CONTRIBUTING.md)

## License

Copyright (c) **Rohan Kumar** and **Junaid Rahim**. All rights reserved. Released under the [MIT](LICENSE) License