Pre classes /cc #29

Author: IonicaBizau

DOCUMENTATION.md

@@ -2,3 +2,22 @@
 
 You can see below the API reference of this module.
 
+### `showdownHighlight()`
+Highlight the code in the showdown input.
+
+Examples:
+
+```js
+let converter = new showdown.Converter({
+    extensions: [showdownHighlight]
+});
+```
+
+Enable the classes in the `<pre>` element:
+
+```js
+let converter = new showdown.Converter({
+    extensions: [showdownHighlight({ pre: true })]
+});
+```
+

README.md

@@ -81,7 +81,10 @@ const showdown = require('showdown')
 // After requiring the module, use it as extension
 let converter = new showdown.Converter({
     // That's it
-    extensions: [showdownHighlight]
+    extensions: [showdownHighlight({
+        // Whether to add the classes to the <pre> tag
+        pre: true
+    })]
 });
 
 // Now you can Highlight code blocks
@@ -133,6 +136,30 @@ There are few ways to get help:
 
 
 
+## :memo: Documentation
+
+
+### `showdownHighlight()`
+Highlight the code in the showdown input.
+
+Examples:
+
+```js
+let converter = new showdown.Converter({
+    extensions: [showdownHighlight]
+});
+```
+
+Enable the classes in the `<pre>` element:
+
+```js
+let converter = new showdown.Converter({
+    extensions: [showdownHighlight({ pre: true })]
+});
+```
+
+
+
 
 
 

example/index.js

@@ -7,7 +7,10 @@ const showdown = require('showdown')
 // After requiring the module, use it as extension
 let converter = new showdown.Converter({
     // That's it
-    extensions: [showdownHighlight]
+    extensions: [showdownHighlight({
+        // Whether to add the classes to the <pre> tag
+        pre: true
+    })]
 });
 
 // Now you can Highlight code blocks

lib/index.js

@@ -6,6 +6,29 @@ const decodeHtml = require("html-encoder-decoder").decode
   , classAttr = 'class="'
   ;
 
+/**
+ * showdownHighlight
+ * Highlight the code in the showdown input.
+ *
+ * Examples:
+ *
+ * ```js
+ * let converter = new showdown.Converter({
+ *     extensions: [showdownHighlight]
+ * });
+ * ```
+ *
+ * Enable the classes in the `<pre>` element:
+ *
+ * ```js
+ * let converter = new showdown.Converter({
+ *     extensions: [showdownHighlight({ pre: true })]
+ * });
+ * ```
+ *
+ * @name showdownHighlight
+ * @function
+ */
 module.exports = function showdownHighlight({ pre = false }) {
   return [
     {