{"repo":"tj-actions/auto-doc","free":true,"listed":false,"github":"https://github.com/tj-actions/auto-doc","clone":"git clone https://github.com/tj-actions/auto-doc.git","description":":octocat: Github action that turns your reusable workflows and custom actions into easy to read markdown tables.","language":"Go","stars":52,"topics":["github-actions","actions","markdown","readme-md","github-action","github","automation","action","yaml","yaml2markdown"],"license":"Apache-2.0","category":"workflow-automation","readme_excerpt":"auto-doc GitHub Action generates a beautiful, easy-to-read markdown table or YAML code block with just a few lines of code. Say goodbye to manual table creation or outdated YAML code blocks and hello to streamlined documentation that is always up-to-date. Features Document your custom Github action using the action.yml file. Document reusable workflows by specifying the filename. Easy to understand markdown table of all inputs, outputs, and secrets. Optional YAML code block for your action.yml file which includes all inputs. Show deprecated inputs. Fast and always up-to-date documentation. Table of Contents Usage Supported Headings Example Inputs Example workflow CLI Installation Install using Go: Install using Homebrew: Install using Chocolatey (Windows): Synopsis Flags Credits Report Bugs Contributors ✨ Usage Add any of the supported headings as a H2 header in any location of your markdown file. Supported Headings Inputs Outputs Secrets (only supported by reusable workflows) Description (only supported by actions) Example 1. Add one or more headings to your README.md \\[!NOTE] This can be multiple headings supported by the input file ## Inputs 2\\. Update your workflow 👇 This was generated 👇 using 👉: action.yml Inputs 👆 This was generated 👆 using 👉 action.yml Example workflow Create a pull request each time the action.yml inputs/outputs change CLI Installation Install using Go: Install using Homebrew: Install using Chocolatey (Windows): Synopsis Automatically generate d","default_branch":null,"files":null,"tree":[],"storefront":"/r/tj-actions","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/tj-actions/auto-doc/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."}