From cc016ac14c3aa3183825b16e67a40b983def9adf Mon Sep 17 00:00:00 2001
From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Date: Tue, 11 Jan 2022 11:50:48 +0100
Subject: [PATCH] docs: add `encodeURIComponent`, `replace` handlebars helpers
(#12672)
---
docs/usage/templates.md | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
diff --git a/docs/usage/templates.md b/docs/usage/templates.md
index 73f333da8c..e4625c5504 100644
--- a/docs/usage/templates.md
+++ b/docs/usage/templates.md
@@ -37,6 +37,27 @@ If you want to print pretty JSON with Handlebars you can use the built-in functi
In the example above `myvar` is a variable/field, that contains valid JSON.
+### encodeURIComponent
+
+If you want to convert a string to a valid URI, use the built-in function `encodeURIComponent` like this:
+
+`{{{encodeURIComponent baseDir}}}`
+
+In the example above `baseDir` is the string you want to transform into a valid URI.
+
+Read the [MDN Web Docs, encodeURIComponent()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) to learn more.
+
+### replace
+
+The `replace` helper replaces _all_ found strings with the replacement string.
+If you want to replace some characters in a string, use the built-in function `replace` like this:
+
+`{{{replace 'github.com', 'ghc', depName}}}`
+
+In the example above all matches of `github.com` will be replaced by `ghc` in `depName`.
+
+Read the [MDN Web Docs, String.prototype.replace()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace) to learn more.
+
### containsString
Returns `true` if a given string is a substring.
--
GitLab