action-docs

{
  "aliases": [],
  "alternatives": [],
  "build_dependencies": [],
  "categories": [],
  "caveats": null,
  "conflicts_with": [],
  "dependencies": [
    "node"
  ],
  "deprecated": 0,
  "deprecation_reason": null,
  "desc": "Generate docs for GitHub actions",
  "disable_reason": null,
  "disabled": 0,
  "enrichment_fetched_at": "2026-06-20T23:35:17+00:00",
  "first_seen": "2026-06-20T23:34:18+00:00",
  "full_name": "action-docs",
  "github_default_branch": "main",
  "github_last_commit_at": "2025-11-14T16:30:38Z",
  "github_readme_excerpt": "\u003c!-- BADGES/ --\u003e\n\n![example workflow](https://github.com/npalm/action-docs/actions/workflows/ci.yml/badge.svg) [![npm](https://img.shields.io/npm/v/action-docs.svg)](https://npmjs.org/package/action-docs) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=action-docs\u0026metric=sqale_rating)](https://sonarcloud.io/dashboard?id=action-docs) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=action-docs\u0026metric=coverage)](https://sonarcloud.io/dashboard?id=action-docs) [![CodeScene Code Health](https://codescene.io/projects/49602/status-badges/code-health)](https://codescene.io/projects/49602)\n\n\u003c!-- /BADGES --\u003e\n\n# Action docs\n\nA 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](https://github.com/npalm/action-docs-action).\n\n## TL;DR\n\n### Add the following comment blocks to your README.md\n\n```md\n\u003c!-- action-docs-header source=\"action.yml\" --\u003e\n\n\u003c!-- action-docs-description source=\"action.yml\" --\u003e # applicable for actions only\n\n\u003c!-- action-docs-inputs source=\"action.yml\" --\u003e\n\n\u003c!-- action-docs-outputs source=\"action.yml\" --\u003e\n\n\u003c!-- action-docs-runs source=\"action.yml\" --\u003e # applicable for actions only\n```\n\nOptionally you can also add the following section to generate a usage guide, replacing \\\u003cproject\\\u003e and \\\u003cversion\\\u003e with the name and version of your project you would like to appear in your usage guide.\n\n```md\n\u003c!-- action-docs-usage source=\"action.yml\" project=\"\u003cproject\u003e\" version=\"\u003cversion\u003e\" --\u003e\n```\n\n### Generate docs via CLI\n\n```bash\nnpm install -g action-docs\ncd \u003cyour github action\u003e\n\n# write docs to console\naction-docs\n\n# update README\naction-docs --update-readme\n```\n\n### Run the cli\n\n```\naction-docs -u\n```\n\n## CLI\n\n### Options\n\nThe following options are available via the CLI\n\n```\nOptions:\n      --version              Show version number                       [boolean]\n  -t, --toc-level   ",
  "github_repo": "npalm/action-docs",
  "github_stars": 103,
  "github_topics": [
    "cli",
    "documentation-generator",
    "github-actions",
    "github-reusable-workflows",
    "hacktoberfest"
  ],
  "homepage": "https://github.com/npalm/action-docs",
  "homepage_og_description": null,
  "homepage_og_image": null,
  "homepage_title": null,
  "installs_30d": 52,
  "installs_365d": 379,
  "installs_90d": 102,
  "keg_only": 0,
  "keg_only_reason": null,
  "last_seen": "2026-06-20T23:34:18+00:00",
  "license": "MIT",
  "llm_generated_at": null,
  "llm_model": null,
  "name": "action-docs",
  "oldnames": [],
  "one_liner": null,
  "optional_dependencies": [],
  "rank_30d": 4569,
  "rank_365d": 5749,
  "rank_90d": 5542,
  "raw_hash": "6782c8b854f768f0",
  "recommended_dependencies": [],
  "revision": 0,
  "ruby_source_path": "Formula/a/action-docs.rb",
  "tap": "homebrew/core",
  "test_dependencies": [],
  "uses_from_macos": [],
  "version_head": null,
  "version_stable": "2.5.1",
  "versioned_formulae": [],
  "why_use_this": null
}