A tool to generate documentation about your Github Action.
actions-docs md
actions-docs md --format=list
actions-docs md --create-file # Creates a new skeleton README with inputs and outputs as table and a simple top-level header and description
The tool can be installed using go get:
go get github.com/rescDev/actions-docs@latestThis will put the binary in $GOPATH/bin. Be sure to add the directory to your $PATH to avoid getting actions-docs: command not found errors.
Binaries are also available on the releases page. Download one of the binaries (e.g. by using curl) and place it into your $PATH.
Detailed usage examples can be found in the examples folder.
NAME:
actions-docs - Generate documentation for your GitHub Action
USAGE:
actions-docs [global options] command [command options]
AUTHOR:
Rene Schach - https://github.com/rescDev
COMMANDS:
markdown, md creates Markdown documentation for the GitHub Action
update perform a self update of the tool to its latest version
GLOBAL OPTIONS:
--help, -h show help (default: false)