{"repo":"npalm/action-docs","free":true,"listed":false,"github":"https://github.com/npalm/action-docs","clone":"git clone https://github.com/npalm/action-docs.git","description":"Generate docs for GitHub actions","language":"TypeScript","stars":103,"topics":["cli","documentation-generator","github-actions","github-reusable-workflows","hacktoberfest"],"license":"MIT","category":"cli-tools","readme_excerpt":"Action docs A CLI to generate and update documentation for GitHub actions or workflows, based on the definition .yml . To update your README in a GitHub workflow you can use the action-docs-action. TL;DR Add the following comment blocks to your README.md Optionally you can also add the following section to generate a usage guide, replacing \\ and \\ with the name and version of your project you would like to appear in your usage guide. Generate docs via CLI Run the cli CLI Options The following options are available via the CLI Update the README Action-docs can update your README based on the action.yml . The following sections can be updated: name header, description, inputs, outputs, usage, and runs. Add the following tags to your README and run action-docs -u . Or to include all of the above, use: For updating other Markdown files add the name of the file to the command action-docs -u . If you need to use another/action.yml : 1. write it in tags like source=\"another/action.yml\" ; 2. specify in a command via the -s option like action-docs -s another/action.yml Examples Print action markdown docs to console Update README.md Print action markdown for non default action file Update readme, custom action file and set TOC level 3, custom readme API Contribution We welcome contributions, please checkout the contribution guide. License This project is released under the MIT License.","default_branch":null,"files":null,"tree":[],"storefront":"/r/npalm","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/npalm/action-docs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}