document new Markdown plugin options (#111, #117)

hegemonic · hegemonic · commit fe33d77f8774 · 2015-11-17T16:10:49.000-08:00
diff --git a/content/en/plugins-markdown.md b/content/en/plugins-markdown.md
@@ -103,3 +103,18 @@ For example, to exclude the `author` tag from Markdown processing:
 }
 ```
 {% endexample %}
+
+
+## Hard-wrapping text at line breaks
+
+By default, the Markdown plugin does not hard-wrap text at line breaks. This is because it's normal
+for a JSDoc comment to be wrapped across multiple lines. If you prefer to hard-wrap text at line
+breaks, set your JSDoc configuration file's `markdown.hardwrap` property to `true`. This property is
+available in JSDoc 3.4.0 and later.
+
+
+## Adding ID attributes to headings
+
+By default, the Markdown plugin does not add an `id` attribute to each HTML heading. To
+automatically add `id` attributes based on the heading's text, set your JSDoc configuration file's
+`markdown.idInHeadings` property to `true`. This property is available in JSDoc 3.4.0 and later.
diff --git a/plugins-markdown.html b/plugins-markdown.html
@@ -36,6 +36,12 @@ <h2>Table of Contents</h2>
       <li>
         <a href="#excluding-the-default-tags-from-markdown-processing">Excluding the default tags from Markdown processing</a>
       </li>
+      <li>
+        <a href="#hard-wrapping-text-at-line-breaks">Hard-wrapping text at line breaks</a>
+      </li>
+      <li>
+        <a href="#adding-id-attributes-to-headings">Adding ID attributes to headings</a>
+      </li>
     </ul>
     <h2 id="overview">Overview</h2>
     <p>JSDoc includes a Markdown plugin that automatically converts Markdown-formatted text to HTML. You can use this plugin with any JSDoc template. In JSDoc 3.2.2
@@ -104,6 +110,14 @@ <h2 id="excluding-the-default-tags-from-markdown-processing">Excluding the defau
 }
 </code></pre>
     </figure>
+    <h2 id="hard-wrapping-text-at-line-breaks">Hard-wrapping text at line breaks</h2>
+    <p>By default, the Markdown plugin does not hard-wrap text at line breaks. This is because it&#39;s normal for a JSDoc comment to be wrapped across multiple lines.
+      If you prefer to hard-wrap text at line breaks, set your JSDoc configuration file&#39;s <code>markdown.hardwrap</code> property to <code>true</code>. This
+      property is available in JSDoc 3.4.0 and later.</p>
+    <h2 id="adding-id-attributes-to-headings">Adding ID attributes to headings</h2>
+    <p>By default, the Markdown plugin does not add an <code>id</code> attribute to each HTML heading. To automatically add <code>id</code> attributes based on the
+      heading&#39;s text, set your JSDoc configuration file&#39;s
+      <code>markdown.idInHeadings</code> property to <code>true</code>. This property is available in JSDoc 3.4.0 and later.</p>
   </article>
   <footer>
     <a class="license-badge" href="http://creativecommons.org/licenses/by-sa/3.0/">
