Metadata-Version: 2.1
Name: mkdocs-helm
Version: 1.0.2
Summary: An mkdocs plugin for publishing helm repository
Home-page: https://github.com/M00nF1sh/mkdocs_helm
Author: M00nF1sh
Author-email: Me_Fortune@qq.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown

# Mkdocs Helm Plugin
An Mkdocs Plugin to turn github pages as an helm repo.

# How to use
1. Adding helm-repo plugin into mkdocs.yaml and configure it.
   ```yaml
   plugins:
    - helm-repo:
        chart: alb-ingress-controller-helm
   ```
1. Supported plugin configurations:
    - chart: Required, path to your helm chart from root directory.
    - chart_dir: Optional(default to 'charts'), http path to host your actual charts
    - helm_repo_url: Optional(default to github pages), intended helm repository url
1. Supported environment variables:
    - HELM_BIN: Optional(default to 'helm') path to your helm binary
    - GIT_BIN: Optional(default to 'git') path to your git binary

