https://github.com/roma-glushko/chartpedia

🧭 Document your helm chart values with ease
https://github.com/roma-glushko/chartpedia

helm helm-charts readme readme-generator

Last synced: about 1 month ago
JSON representation

🧭 Document your helm chart values with ease

• Host: GitHub
• URL: https://github.com/roma-glushko/chartpedia
• Owner: roma-glushko
• License: apache-2.0
• Created: 2024-02-09T11:39:06.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-08-08T19:57:00.000Z (5 months ago)
• Last Synced: 2024-10-31T22:09:32.037Z (3 months ago)
• Topics: helm, helm-charts, readme, readme-generator
• Language: Rust
• Homepage:
• Size: 473 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    

    
🧭 chartpedia



A convenient way to document your Helm charts using short metadata in a values.yaml file:

```yaml

## @section Image Details

## @descriptionStart

## Redis Image Configuration

## Ref: https://hub.docker.com/_/redis

## @descriptionEnd

##

image:

  ## @param image.repository [default: redis] Redis image repistory

  repository: redis

  ## @param image.tag Redis image tag or a digest (in a form of sha256:aa..)

  tag: 7.2.4

  ## @param image.pullPolicy Image pull policy

  pullPolicy: IfNotPresent

  ## @param image.pullSecrets Specify docker-registry secret names as an array

  pullSecrets: []

```

## Features

- 📦 Easy to install on MacOS, Linux, and Windows. Everything is packed into one slim binary.

- ✅ Fully compatible with the original [Bitnami Readme Generator](https://github.com/bitnami/readme-generator-for-helm/) format. If you are already using it, no change is needed to your values.yaml metadata to get started.

- 🛠️ Support JSON and YAML configs

- 👷 CI-friendly `check` command

- 🦀 Written in blazing-fast Rust

## Installation

Coming soon

## Usage

Coming soon

# Credits

The idea is taken from [the Bitnami Readme Generator](https://github.com/bitnami/readme-generator-for-helm/)

Made with ❤️ by [Roma Hlushko](https://github.com/roma-glushko), Apache-2.0.