action-doc

action-doc takes your action's action.yml as input and outputs some markdown suitable for a README.md

Usage

action-doc ./action.yml > README.md

Usage: action-doc <action-config>

Arguments:
  <action-config>    action.yml to parse

Flags:
  -h, --help                            Show context-sensitive help.
      --version                         Show version and exit
      --skip-action-author              Skip outputting the action author
      --skip-action-name                Skip outputting the action name
      --skip-action-description         Skip outputting the action description
      --post-description-text=STRING    Some text to insert after the description
      --header-prefix=STRING            Some extra #s for the markdown headers

Install

go get

go get -u github.com/willabides/action-doc/cmd/action-doc

bindown

Add a bindown dependency:

$ bindown template-source add action-doc https://raw.githubusercontent.com/WillAbides/action-doc/main/bindown.yml
$ bindown dependency add action-doc action-doc#action-doc
Please enter a value for required variable "version":	<latest version>