Giter VIP home page Giter VIP logo

action2md's Introduction

action2md

Takes an action.yaml document and prints out a reference table for it's inputs:

action2md action.yaml

Outputs something like:

| Input               | Description         | Default | Required |
| ------------------- | ------------------- | ------- | -------- |
| `file`              | Some important file |         | ✔        |
| `optionA`           | A                   |         |          |
| `optionWithDefault` | B                   | `foo`   |          |

Reference

$ action2md action.yaml
    Usage
        $ action2md [action.yaml]

    Options
        --output, -o  Optionally, where to send output
        --help        Show help
        --version     Print package version

    Examples
        $ action2md
        | Input               | Description         | Default | Required |
        | ------------------- | ------------------- | ------- | -------- |
        | `file`              | Some important file |         | ✔        |
        | `optionA`           | A                   |         |          |
        | `optionWithDefault` | B                   | `foo`   |          |

action2md's People

Contributors

richicoder1 avatar

Watchers

avatar avatar avatar

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.