Skip to content

docs(unescaped-markup): remove duplicated doc sections #4094

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Hashim1999164 wants to merge 1 commit into
base: v2
Choose a base branch
from
+5 −104
Open

docs(unescaped-markup): remove duplicated doc sections #4094

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 5 additions & 104 deletions src/plugins/unescaped-markup/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,113 +34,14 @@ This will only work if the `code` element contains exactly one comment and nothi

# Examples

View source to see that the following didn’t need escaping (except for <code>&lt;/script></code>, that does):

<script type="text/plain"><!DOCTYPE html>
<html lang="en">
<head>

<meta charset="utf-8" />
<link rel="icon" href="https://prismjs.com/assets/favicon.png" />
<title>Keep markup ▲ Prism plugins</title>
<base href=".." />
<link rel="stylesheet" href="https://prismjs.com/assets/style.css" />
<link rel="stylesheet" href="https://dev.prismjs.com/themes/prism.css" />

</head>
<body class="language-markup">

<header>
<h2>Unescaped markup</h2>
<p>Write markup without having to escape anything.</p>
</header>

<section>
<h1>How to use</h1>
<p>Instead of using <code>&lt;pre>&lt;code></code> elements, use <code>&lt;script type="text/plain"></code>:</p>
</section>

<section>
<h1>FAQ</h1>

<p>Why not use the HTML <code>&lt;template></code> tag?</p>

<p>Because it is a PITA to get its <code>textContent</code> and needs to be pointlessly cloned.
Feel free to implement it yourself and send a pull request though, if you are so inclined.</p>

<p>Can I use this inline?</p>

<p>Not out of the box, because I figured it’s more of a hassle to type <code>&lt;script type="text/plain"></code> than escape the 1-2 <code>&lt;</code> characters you need to escape in inline code.
Also inline code is not as frequently copy-pasted, which was the major source of annoyance that got me to write this plugin.</p>
</section>

<section>
<h1>Examples</h1>

<p>With <code>&lt;script type="text/plain"></code>:</p>

<script type="text/plain"><div><span>Foo</span></div>&lt;/script>
</section>

<script src="https://dev.prismjs.com/prism.js">&lt;/script>
<script src="unescaped-markup/unescaped-markup.js">&lt;/script>

</body>
</html></script>

<p>The next example uses the HTML-comment method:</p>

<pre><code><!--<!DOCTYPE html>
<html lang="en">
<head>
With `<script type="text/plain">` (view source; only `</script>` needs escaping):

<meta charset="utf-8" />
<link rel="icon" href="https://prismjs.com/assets/favicon.png" />
<title>Keep markup ▲ Prism plugins</title>
<base href=".." />
<link rel="stylesheet" href="https://prismjs.com/assets/style.css" />
<link rel="stylesheet" href="https://dev.prismjs.com/themes/prism.css" />

</head>
<body class="language-markup">

<header>
<h2>Unescaped markup</h2>
<p>Write markup without having to escape anything.</p>
</header>

<section>
<h1>How to use</h1>
<p>Instead of using <code>&lt;pre>&lt;code></code> elements, use <code>&lt;script type="text/plain"></code>:</p>
</section>

<section>
<h1>FAQ</h1>

<p>Why not use the HTML <code>&lt;template></code> tag?</p>

<p>Because it is a PITA to get its <code>textContent</code> and needs to be pointlessly cloned.
Feel free to implement it yourself and send a pull request though, if you are so inclined.</p>

<p>Can I use this inline?</p>

<p>Not out of the box, because I figured it’s more of a hassle to type <code>&lt;script type="text/plain"></code> than escape the 1-2 <code>&lt;</code> characters you need to escape in inline code.
Also inline code is not as frequently copy-pasted, which was the major source of annoyance that got me to write this plugin.</p>
</section>

<section>
<h1>Examples</h1>

<p>With <code>&lt;script type="text/plain"></code>:</p>

<script type="text/plain"><div><span>Foo</span></div></script>
</section>
<script type="text/plain"><p>Example with <strong>unescaped</strong> markup</p>
</script>

<script src="https://dev.prismjs.com/prism.js"></script>
<script src="unescaped-markup/unescaped-markup.js"></script>
With the HTML-comment method:

</body>
</html>--></code></pre>
<pre><code><!--<p>Example with <strong>unescaped</strong> markup</p>--></code></pre>

</section>

Expand Down
Loading