helm-docs

{
  "aliases": [],
  "alternatives": [],
  "build_dependencies": [
    "go"
  ],
  "categories": [],
  "caveats": null,
  "conflicts_with": [],
  "dependencies": [],
  "deprecated": 0,
  "deprecation_reason": null,
  "desc": "Tool for automatically generating markdown documentation for helm charts",
  "disable_reason": null,
  "disabled": 0,
  "enrichment_fetched_at": "2026-06-20T23:38:36+00:00",
  "first_seen": "2026-06-20T23:34:18+00:00",
  "full_name": "helm-docs",
  "github_default_branch": "master",
  "github_last_commit_at": "2026-06-15T09:31:36Z",
  "github_readme_excerpt": "helm-docs\n=========\n[![Go Report Card](https://goreportcard.com/badge/github.com/norwoodj/helm-docs)](https://goreportcard.com/report/github.com/norwoodj/helm-docs)\n\nThe helm-docs tool auto-generates documentation from helm charts into markdown files. The resulting\nfiles contain metadata about their respective chart and a table with each of the chart\u0027s values, their defaults, and an\noptional description parsed from comments.\n\nThe markdown generation is entirely [gotemplate](https://golang.org/pkg/text/template) driven. The tool parses metadata\nfrom charts and generates a number of sub-templates that can be referenced in a template file (by default `README.md.gotmpl`).\nIf no template file is provided, the tool has a default internal template that will generate a reasonably formatted README.\n\nThe most useful aspect of this tool is the auto-detection of field descriptions from comments:\n```yaml\nconfig:\n  databasesToCreate:\n    # -- default database for storage of database metadata\n    - postgres\n\n    # -- database for the [hashbash](https://github.com/norwoodj/hashbash-backend-go) project\n    - hashbash\n\n  usersToCreate:\n    # -- admin user\n    - {name: root, admin: true}\n\n    # -- user with access to the database with the same name\n    - {name: hashbash, readwriteDatabases: [hashbash]}\n\nstatefulset:\n  image:\n    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files\n    repository: jnorwood/postgresql\n    tag: \"11\"\n\n  # -- Additional volumes to be mounted into the database container\n  extraVolumes:\n    - name: data\n      emptyDir: {}\n```\n\nResulting in a resulting README section like so:\n\n| Key | Type | Default | Description |\n|-----|------|---------|-------------|\n| config.databasesToCreate[0] | string | `\"postgresql\"` | default database for storage of database metadata |\n| config.databasesToCreate[1] | string | `\"hashbash\"` | database for the [hashbash](https://github.com/norwoodj/hashbash-backend-go) p",
  "github_repo": "norwoodj/helm-docs",
  "github_stars": 1746,
  "github_topics": [],
  "homepage": "https://github.com/norwoodj/helm-docs",
  "homepage_og_description": null,
  "homepage_og_image": null,
  "homepage_title": null,
  "installs_30d": 123,
  "installs_365d": 1403,
  "installs_90d": 335,
  "keg_only": 0,
  "keg_only_reason": null,
  "last_seen": "2026-06-20T23:34:18+00:00",
  "license": "GPL-3.0-or-later",
  "llm_generated_at": null,
  "llm_model": null,
  "name": "helm-docs",
  "oldnames": [],
  "one_liner": null,
  "optional_dependencies": [],
  "rank_30d": 3205,
  "rank_365d": 3303,
  "rank_90d": 3369,
  "raw_hash": "ab97d1c07fb66329",
  "recommended_dependencies": [],
  "revision": 0,
  "ruby_source_path": "Formula/h/helm-docs.rb",
  "tap": "homebrew/core",
  "test_dependencies": [],
  "uses_from_macos": [],
  "version_head": "HEAD",
  "version_stable": "1.14.2",
  "versioned_formulae": [],
  "why_use_this": null
}