Merge pull request #61 from norwoodj/fix-dash-versions

fix: escapes dashes in version badges so complicated versions work fi…

Author: norwoodj

example-charts/funky-version/Chart.yaml

@@ -0,0 +1,10 @@
+apiVersion: v2
+name: funky-version
+description: A very simple chart with a funky version
+version: "0.1.0-alpha-rc2"
+home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/funky-version"
+sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/funky-version"]
+engine: gotpl
+maintainers:
+  - email: [email protected]
+    name: John Norwood

example-charts/funky-version/README.md

@@ -0,0 +1,18 @@
+# funky-version
+
+![Version: 0.1.0-alpha-rc2](https://img.shields.io/badge/Version-0.1.0--alpha--rc2-informational?style=flat-square)
+
+A very simple chart with a funky version
+
+**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/funky-version>
+
+## Maintainers
+
+| Name | Email | Url |
+| ---- | ------ | --- |
+| John Norwood | [email protected] |  |
+
+## Source Code
+
+* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/funky-version>
+

example-charts/funky-version/values.yaml

@@ -62,7 +62,7 @@ func getVersionTemplates() string {
 	versionBuilder := strings.Builder{}
 	versionBuilder.WriteString(`{{ define "chart.version" }}{{ .Version }}{{ end }}\n`)
 	versionBuilder.WriteString(`{{ define "chart.versionBadge" }}`)
-	versionBuilder.WriteString("![Version: {{ .Version }}](https://img.shields.io/badge/Version-{{ .Version }}-informational?style=flat-square) ")
+	versionBuilder.WriteString(`![Version: {{ .Version }}](https://img.shields.io/badge/Version-{{ .Version | replace "-" "--" }}-informational?style=flat-square) `)
 	versionBuilder.WriteString("{{ end }}")
 
 	return versionBuilder.String()