☰ 菜单
命令行 开源 161 次安装/月

helm-docs for Mac 版

helm-docs

用于自动生成 Helm 图表的 Markdown 文档的工具

helm-docs 是什么

helm-docs 是一个从 Helm Chart 自动生成 Markdown 文档的工具。它会解析 Chart 的元数据,并读取 values.yaml 中每个字段的默认值以及注释里的描述,最终生成一份包含 Chart 基本信息和 values 表格的 README。文档生成完全由 Go template 驱动,工具会提供若干子模板供自定义模板文件(默认 README.md.gotmpl)引用;如果没有提供模板,则使用内置的默认模板输出格式合理的 README。

它最实用的地方在于能从注释中自动提取字段描述,省去手动维护 values 文档的麻烦。对于列表、对象等复杂字段以及部分简单字段,工具会按既定规则决定是否纳入表格,即使没有描述注释也能处理某些字段。

这个工具适合需要为多个 Helm Chart 维护文档的开发者,尤其是 Chart 数量多、values 结构复杂、文档容易过时的场景。它支持递归查找当前目录下的 Chart.yaml 并为每个 Chart 生成文档,也可以通过 Docker 挂载目录运行,还提供 pre-commit hook 在提交时自动更新文档。此外,它支持用 .helmdocsignore 文件忽略特定 Chart 目录。

如何安装 helm-docs

  1. 打开 终端(按 ⌘ + 空格,输入“终端”)。
  2. 如果还没安装 Homebrew,先运行下面这条安装命令。
  3. 运行下面这条命令:

最近 10 个版本记录

最近一次更新为 2024-07-08,当前版本 v1.14.2,共记录最近 10 个版本。

版本发布日期类型大小macOSWindowsLinux
v1.14.22024-07-08稳定版3.0 MB下载下载下载
v1.14.12024-07-08稳定版3.0 MB下载下载下载
v1.14.02024-07-08稳定版3.0 MB下载下载下载
v1.13.12024-03-02稳定版3.0 MB下载下载下载
v1.13.02024-02-24稳定版3.0 MB下载下载下载
v1.12.02023-12-21稳定版3.1 MB下载下载下载
v1.11.32023-10-10稳定版3.0 MB下载下载下载
v1.11.22023-09-19稳定版2.8 MB下载下载下载
v1.11.02022-06-29稳定版2.6 MB下载下载下载
v1.10.02022-05-10稳定版2.6 MB下载下载下载

数据来自 GitHub Releases,稳定版优先,同类按发布时间排序。

二进制包支持平台

Homebrew 官方提供的预编译包(bottle)覆盖:

  • Apple 芯片 · 最新 macOS
  • Apple 芯片 · macOS 26 Tahoe
  • Apple 芯片 · macOS 15 Sequoia
  • Apple 芯片 · macOS 14 Sonoma
  • Apple 芯片 · macOS 13 Ventura
  • arm64_monterey
  • Intel · macOS 14 Sonoma
  • Intel · macOS 13 Ventura
  • Intel · macOS 12 Monterey
  • Linux · ARM64
  • Linux · x86_64

与同类应用对比

只对比公开元数据,不做主观推荐;需要逐项对比时见对比页。

与同类应用对比
应用版本许可证架构近 30 天安装
helm-docsv1.14.2GPL-3.0-or-later命令行161
valsv0.51.0Apache-2.0命令行98
chart-testingv3.15.0Apache-2.0命令行342
helm-lsv0.5.4MIT命令行57

DevOps 与云服务中的类似应用

发表评论

电子邮件地址不会被公开。必填项已用 * 标注。