chore(docs): add escape_html doc (hexojs#1576)

guorant · Dec 17, 2020 · dd8c202 · dd8c202
1 parent b09526d
commit dd8c202
Show file tree

Hide file tree

Showing 7 changed files with 105 additions and 0 deletions.
diff --git a/source/docs/helpers.md b/source/docs/helpers.md
@@ -465,6 +465,21 @@ Truncates text after certain `length`. Default is 30 characters.
 // And they f... (continued)
 ```
 
+### escape_html
+
+Escapes HTML entities in a string.
+
+``` js
+<%- escape_html(str) %>
+```
+
+**Examples:**
+
+``` js
+<%- escape_html('<p>Hello "world".</p>') %>
+// &lt;p&gt;Hello &quot;world&quot;.&lt;&#x2F;p&gt;
+```
+
 ## Templates
 
 ### partial

diff --git a/source/ko/docs/helpers.md b/source/ko/docs/helpers.md
@@ -380,6 +380,21 @@ See [Rendering](https://hexo.io/ko/api/rendering) for more details.
 // And they f... (continued)
 ```
 
+### escape_html
+
+Escapes HTML entities in a string.
+
+``` js
+<%- escape_html(str) %>
+```
+
+**Examples:**
+
+``` js
+<%- escape_html('<p>Hello "world".</p>') %>
+// &lt;p&gt;Hello &quot;world&quot;.&lt;&#x2F;p&gt;
+```
+
 ## 템플릿
 
 ### partial

diff --git a/source/pt-br/docs/helpers.md b/source/pt-br/docs/helpers.md
@@ -385,6 +385,21 @@ Omite o texto após um certo valor de `length`. O valor padrão de `length` é 3
 // And they f... (continued)
 ```
 
+### escape_html
+
+Escapes HTML entities in a string.
+
+``` js
+<%- escape_html(str) %>
+```
+
+**Examples:**
+
+``` js
+<%- escape_html('<p>Hello "world".</p>') %>
+// &lt;p&gt;Hello &quot;world&quot;.&lt;&#x2F;p&gt;
+```
+
 ## Templates
 
 ### partial

diff --git a/source/ru/docs/helpers.md b/source/ru/docs/helpers.md
@@ -379,6 +379,21 @@ See [Rendering](https://hexo.io/ru/api/rendering) for more details.
 // And they f... (continued)
 ```
 
+### escape_html
+
+Escapes HTML entities in a string.
+
+``` js
+<%- escape_html(str) %>
+```
+
+**Examples:**
+
+``` js
+<%- escape_html('<p>Hello "world".</p>') %>
+// &lt;p&gt;Hello &quot;world&quot;.&lt;&#x2F;p&gt;
+```
+
 ## Шаблоны
 
 ### partial

diff --git a/source/th/docs/helpers.md b/source/th/docs/helpers.md
@@ -403,6 +403,21 @@ See [Rendering](https://hexo.io/th/api/rendering) for more details.
 // And they f... (continued)
 ```
 
+### escape_html
+
+Escapes HTML entities in a string.
+
+``` js
+<%- escape_html(str) %>
+```
+
+**Examples:**
+
+``` js
+<%- escape_html('<p>Hello "world".</p>') %>
+// &lt;p&gt;Hello &quot;world&quot;.&lt;&#x2F;p&gt;
+```
+
 ## Templates
 
 ### partial

diff --git a/source/zh-cn/docs/helpers.md b/source/zh-cn/docs/helpers.md
@@ -459,6 +459,21 @@ See [Rendering](https://hexo.io/zh-cn/api/rendering) for more details.
 // And they f... (continued)
 ```
 
+### escape_html
+
+Escapes HTML entities in a string.
+
+``` js
+<%- escape_html(str) %>
+```
+
+**Examples:**
+
+``` js
+<%- escape_html('<p>Hello "world".</p>') %>
+// &lt;p&gt;Hello &quot;world&quot;.&lt;&#x2F;p&gt;
+```
+
 ## 模板
 
 ### partial

diff --git a/source/zh-tw/docs/helpers.md b/source/zh-tw/docs/helpers.md
@@ -369,6 +369,21 @@ See [Rendering](https://hexo.io/zh-twapi/rendering) for more details.
 // Once upon a time
 ```
 
+### escape_html
+
+Escapes HTML entities in a string.
+
+``` js
+<%- escape_html(str) %>
+```
+
+**Examples:**
+
+``` js
+<%- escape_html('<p>Hello "world".</p>') %>
+// &lt;p&gt;Hello &quot;world&quot;.&lt;&#x2F;p&gt;
+```
+
 ## 模板
 
 ### partial