https://github.com/d-rk/helm-doc

a helm plugin for documentation generation
https://github.com/d-rk/helm-doc

documentation-generator golang helm helm-chart helm-plugin kubernetes

Last synced: 7 months ago
JSON representation

a helm plugin for documentation generation

• Host: GitHub
• URL: https://github.com/d-rk/helm-doc
• Owner: d-rk
• License: apache-2.0
• Created: 2019-06-14T06:03:19.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-06-14T12:08:16.000Z (over 6 years ago)
• Last Synced: 2023-03-01T01:03:21.483Z (almost 3 years ago)
• Topics: documentation-generator, golang, helm, helm-chart, helm-plugin, kubernetes
• Language: Go
• Size: 41 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# helm-doc

a helm plugin for documentation generation

[![Build Status](https://travis-ci.com/random-dwi/helm-doc.svg?branch=master)](https://travis-ci.com/random-dwi/helm-doc)

## installation

choose the variant needed and install with the following:

```bash

version=0.2.1

#variant=Linux_x86_64

#variant=Linux_i386

#variant=Darwin_x86_64

#variant=Darwin_i386

helm plugin install https://github.com/random-dwi/helm-doc/releases/download/${version}/helm-doc_${version}_${variant}.tar.gz

# workaround to fix file permissions

find `helm home` -name helm-doc | xargs -L1 chmod +x

```

## usage

```sh

# show help

helm doc -h

# generate doc for a chart

helm doc [chart]

```