Giter VIP home page Giter VIP logo

argodocs's Introduction

argodocs

Go Reference GitHub release (latest SemVer) build License: 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

License

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

argodocs's People

Contributors

dependabot[bot] avatar junaidrahim avatar rohankmr414 avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

fossabot

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.