Unescaped Markup: More doc regarding comments (#2652) This makes the explanation of the usage of comments clearer and gives examples.
diff --git a/plugins/unescaped-markup/index.html b/plugins/unescaped-markup/index.html
index 5efc7ab..a030909 100644
--- a/plugins/unescaped-markup/index.html
+++ b/plugins/unescaped-markup/index.html
@@ -24,15 +24,23 @@
<p>This plugin provides several methods of achieving the same thing:</p>
<ul>
- <li>Instead of using <code><pre><code></code> elements, use <code><script type="text/plain"></code>
- <pre><code><script type="text/plain" class="language-markup">
+ <li>
+ Instead of using <code><pre><code></code> elements, use <code><script type="text/plain"></code>:
+
+ <pre><code><script type="text/plain" class="language-markup">
<p>Example</p>
</script></code></pre>
</li>
- <li>Use a HTML-comment to escape your code
- <pre><code><pre class="language-markup"><code><!--
+ <li>
+ Use an HTML-comment to escape your code:
+
+ <pre><code><pre class="language-markup"><code><!--
<p>Example</p>
---></code></pre></code></pre></li>
+--></code></pre></code></pre>
+
+ This will only work if the <code>code</code> element contains exactly one comment and nothing else (not even spaces).
+ E.g. <code><code> <!-- some text --></code></code> and <code><code>text<!-- more text --></code></code> will not work.
+ </li>
</ul>
</section>