Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 1,000,000+ packages pre-installed, including github-action-readme-generator with all npm packages installed. Try it out:

var githubActionReadmeGenerator = require("github-action-readme-generator")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

github-action-readme-generator v1.7.2

This is a CLI tool and GitHub Action that reads in the details from a GitHub Action's `action.yml` file and updates the `README.md` file with the `name`, `description`, `usage`, `inputs`, `outputs`, and examples of the action. Configuration can be provided via a `.ghadocs.json` file stored in the root directory of the Action's repository, via the command line when using the cli, or via the `with:` section of this Action. This tool uses markdown comments as delimiting tokens within the `README.md` file to determine where to place the generated content. [`README.example.md`](README.example.md) example with all fields filled in, and no other free-form content.

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free