diff --git a/plugins/line-numbers/index.html b/plugins/line-numbers/index.html index 6b81b43ccf..0fcb2af8a9 100644 --- a/plugins/line-numbers/index.html +++ b/plugins/line-numbers/index.html @@ -22,7 +22,25 @@

How to use

Obviously, this is supposed to work only for code blocks (<pre><code>) and not for inline code.

-

Add the line-numbers class to your desired <pre> or any of its ancestors, and the line-numbers plugin will take care of the rest. To give all code blocks line numbers, add the line-numbers class to the <body> of the page.

+

Add the line-numbers class to your desired <pre> or any of its ancestors, and the Line Numbers plugin will take care of the rest. To give all code blocks line numbers, add the line-numbers class to the <body> of the page. This is part of a general activation mechanism where adding the line-numbers (or no-line-numbers) class to any element will enable (or disable) the Line Numbers plugin for all code blocks in that element.
Example:

+ +
<body class="line-number"> <!-- enabled for the whole page -->
+
+	<!-- with line numbers -->
+	<pre><code>...</code></pre>
+	<!-- disabled for a specific element - without line numbers -->
+	<pre class="no-line-numbers"><code>...</code></pre>
+
+	<div class="no-line-numbers"> <!-- disabled for this subtree -->
+
+		<!-- without line numbers -->
+		<pre><code>...</code></pre>
+		<!-- enabled for a specific element - with line numbers -->
+		<pre class="line-number"><code>...</code></pre>
+
+	</div>
+</body>
+

Optional: You can specify the data-start (Number) attribute on the <pre> element. It will shift the line counter.

Optional: To support multiline line numbers using soft wrap, apply the CSS white-space: pre-line; or white-space: pre-wrap; to your desired <pre>.