Add docs

Bloggify · Sep 18, 2022 · a02528b · a02528b
1 parent 700cb4f
commit a02528b
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/lib/index.js b/lib/index.js
@@ -25,6 +25,18 @@ const decodeHtml = require("html-encoder-decoder").decode
  * })
  * ```
  *
+ *
+ * If you want to disable language [auto detection](https://highlightjs.org/usage/)
+ * feature of hljs, change `auto_detection` flag as `false`. With this option
+ * turned off, `showdown-highlight` will not process any codeblocks with no
+ * language specified.
+ *
+ * ```js
+ * let converter = new showdown.Converter({
+ *     extensions: [showdownHighlight({ auto_detection: false })]
+ * })
+ * ```
+ *
  * @name showdownHighlight
  * @function
  */