Helm-Docs 使用教程

Helm-Docs 使用教程

helm-docsA tool for automatically generating markdown documentation for helm charts项目地址:https://gitcode.com/gh_mirrors/he/helm-docs

1. 项目介绍

Helm-Docs 是一个自动化工具，用于从 Helm 图表自动生成 Markdown 格式的文档。这些文件包含了图表的元数据以及表格形式的配置值，默认值及可选描述。通过解析 YAML 文件中的注释，该工具可以自动检测字段描述，使得文档更新更为便捷。默认情况下，它会生成一个格式化的 README.md 文件，但也可以自定义模板以满足不同的需求。

2. 项目快速启动

安装 Helm-Docs

Homebrew（MacOS）

brew install norwoodj/tap/helm-docs

Scoop（Windows）

scoop install helm-docs

从源码构建

cd cmd/helm-docs
go build

或

go install github.com/norwoodj/helm-docs/cmd/helm-docs@latest

预提交钩子（自动更新文档）

在项目中添加 pre-commit-config.yaml 文件：

repos:
- repo: https://github.com/norwoodj/helm-docs
  rev: ""
  hooks:
    - id: helm-docs
      args: 
        - --chart-search-root=charts

然后执行：

pre-commit install
pre-commit install-hooks

这样每次提交前都会检查并更新文档。

3. 应用案例与最佳实践

• 为新的Helm Chart创建文档： 在项目目录下运行：

  helm-docs
  

• 自定义模板： 创建 README.md.gotmpl 模板文件，并替换默认的内部模板。

• 保持文档同步： 将 Helm-Docs 集成到持续集成流程中，确保每次代码变动时文档都能及时更新。

4. 典型生态项目

Helm-Docs 可广泛应用于任何基于 Helm 的 Kubernetes 应用部署，如 Kubernetes官方Charts 或者 Kubernetes社区Charts，以及其他个人或组织的私有Helm仓库。

---

以上即为 Helm-Docs 的基本介绍、快速上手指南、实用示例和生态系统介绍。通过此教程，您应能够轻松地为您的Helm Charts构建文档并实现自动化维护。

helm-docsA tool for automatically generating markdown documentation for helm charts项目地址:https://gitcode.com/gh_mirrors/he/helm-docs