Skip to main content

An mkdocs plugin for publishing helm repository

Project description

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.
    plugins:
     - helm-repo:
         chart: alb-ingress-controller-helm
    
  2. 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
  3. 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_helm-1.0.2.tar.gz (2.4 kB view hashes)

Uploaded source

Built Distribution

mkdocs_helm-1.0.2-py3-none-any.whl (7.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page