diff --git a/docs/available-options.md b/docs/available-options.md
new file mode 100644
index 0000000..114244c
--- /dev/null
+++ b/docs/available-options.md
@@ -0,0 +1,773 @@
+!!! warning ""
+ Starting from the version `1.6.0` and earlier, all the options are `disabled` by default in the cli tool.
+
+### omitExtraWLInCodeBlocks
+
+Omit trailing newline in code blocks (which is set by default before the closing tag). This option affects both indented and fenced (gfm style) code blocks.
+
+* type: `boolean`
+* default value: `false`
+* introduced in: `1.0.0`
+
+=== "input"
+
+ ```
+ var foo = 'bar';
+ ```
+
+=== "output (value is `false`)"
+
+ ```html
+
+ ```
+
+=== "output (value is `true`)"
+
+ ```html
+ var foo = 'bar';
+
+ ```
+
+### noHeaderId
+
+Disable automatic generation of heading IDs.
+
+!!! warning ""
+ Setting the option to `true` overrides the following options:
+
+ * [`prefixHeaderId`](#prefixheaderid)
+ * [`customizedHeaderId`](#customizedheaderid)
+ * [`ghCompatibleHeaderId`](#ghcompatibleheaderid)
+
+* type: `boolean`
+* default value: `false`
+* introduced in: `1.1.0`
+
+=== "input"
+
+ ```
+ # This is a heading
+ ```
+
+=== "output (value is `false`)"
+
+ ```html
+ var foo = 'bar';
Lorem ipsum www.google.com
+ ``` + +=== "output (value is `true`)" + + ```html +Lorem ipsum www.google.com
+ ``` + +### excludeTrailingPunctuationFromURLs + +Exclude trailing punctuation from autolinked URLs: `.` `!` `?` `(` `)` + +This option applies only to links generated by [`simplifiedAutoLink`](#simplifiedautolink). + +* type: `boolean` +* default value: `false` +* introduced in: `1.5.1` + +=== "input" + + ``` + check this link www.google.com. + ``` + +=== "output (value is `false`)" + + ```html +check this link www.google.com.
+ ``` + +=== "output (value is `true`)" + + ```html +check this link www.google.com.
+ ``` + +### literalMidWordUnderscores + +Treat underscores in the middle of words as literal characters. + +Underscores allow you to specify the words that should be emphasized. However, in some cases, this may be unwanted behavior. With this option enabled, underscores in the middle of words will no longer be interpreted as `` and ``, but as literal underscores. + +* type: `boolean` +* default value: `false` +* introduced in: `1.2.0` + +=== "input" + + ``` + some text with__underscores__in the middle + ``` + +=== "output (value is `false`)" + + ```html +some text withunderscoresin the middle
+ ``` + +=== "output (value is `true`)" + + ```html +some text with__underscores__in the middle
+ ``` + +### strikethrough + +Enable support for strikethrough (`hello there @tivie
+ ``` + +=== "output (value is `true`)" + + ```html +hello there @tivie
+ ``` + +### ghMentionsLink + +Specify where the link generated by `@mentions` should point to. Works only when [`ghMentions: true`](#ghmentions). + +* type: `boolean` +* default value: `https://github.com/{u}` +* introduced in: `1.6.2` + +=== "input" + + ``` + hello there @tivie + ``` + +=== "output (value is `https://github.com/{u}`)" + + ```html +hello there @tivie
+ ``` + +=== "output (value is `http://mysite.com/{u}/profile`)" + + ```html +hello there @tivie
+ ``` + +### smoothLivePreview + +Resolve an awkward effect when a paragraph is followed by a list. This effect appears on some circumstances, in live preview editors. + +* type: `boolean` +* default value: `false` +* introduced in: `1.2.1` + +!!! example "awkward effect" + + ![](http://i.imgur.com/YQ9iHTL.gif) + +### smartIndentationFix + +Resolve indentation problems related to ES6 template strings in the midst of indented code. + +* type: `boolean` +* default value: `false` +* introduced in: `1.4.2` + +### disableForced4SpacesIndentedSublists + +Disable the rule of 4 spaces to indent sub-lists. If enabled, this option effectively reverts to the old behavior where you can indent sub-lists with 2 or 3 spaces. + +* type: `boolean` +* default value: `false` +* introduced in: `1.5.0` + +=== "input" + + ``` + - one + - two + + ... + + - one + - two + ``` + +=== "output (value is `false`)" + + ```html +...
+...
+a line + wrapped in two
+ ``` + +=== "output (value is `true`)" + + ```html +a line
+ wrapped in two
#heading
+ ``` + +### encodeEmails + +Enable automatic obfuscation of email addresses. During this process, email addresses are encoded via Character Entities, transforming ASCII email addresses into their equivalent decimal entities. + +* type: `boolean` +* default value: `false` +* introduced in: `1.6.1` + +=== "input" + + ``` +<div>foo</div>
+ ``` + +### emoji + +Enable emoji support. For more info on available emojis, see https://github.com/showdownjs/showdown/wiki/Emojis (since v.1.8.0) + +* type: `boolean` +* default value: `false` +* introduced in: `1.8.0` + +=== "input" + + ``` + this is a :smile: emoji + ``` + +=== "output (value is `false`)" + + ```html +this is a :smile: emoji
+ ``` + +=== "output (value is `true`)" + + ```html +this is a 😄 emoji
+ ``` + +!!! hint "Full list of supported emojies" + + Check the [Showdown Wiki](https://github.com/showdownjs/showdown/wiki/Emojis#emoji-list) for a full list of supported emojies. + +### underline + +Enable support for underline. If enabled, underscores will no longer be parsed as `` and ``. + +* type: `boolean` +* default value: `false` +* status: `Experimental` + +=== "example" + + ``` + __underlined word__ // double underscores + + ___underlined word___ // triple underscores + ``` + +### completeHTMLDocument + +Output a complete HTML document, including ``, ``, and `` tags instead of an HTML fragment. + +* type: `boolean` +* default value: `false` +* introduced in: `1.8.5` + +### metadata + +Enable support for document metadata (front-matter). You can define metadata at the top of a document between `««« »»»` or `--- ---` symbols. + +* type: `boolean` +* default value: `false` +* introduced in: `1.8.5` + +=== "input" + + ```js + let ref = `referenced value`; + + var markdown = ` + --- + first: Lorem + second: Ipsum + ref_variable: ${ref} + --- + ` + + var conv = new showdown.Converter({metadata: true}); + var html = conv.makeHtml(markdown); + var metadata = conv.getMetadata(); + ``` + +=== "output (value is `true`)" + + ```js + // console.log(metadata) + { + first: 'Lorem', + second: 'Ipsum', + ref_variable: 'referenced value' + } + ``` + +### splitAdjacentBlockquotes + +Split adjacent blockquote blocks. + +* type: `boolean` +* default value: `false` +* introduced in: `1.8.6` + +=== "input" + + ``` + > Quote #1 + >> Sub-quote 1 + + > Quote #2 + >> Sub-quote 2 + ``` + +=== "output (value is `false`)" + + ```html +++ ``` + +=== "output (value is `true`)" + + ```html +Quote #1
+++Sub-quote 1
+Quote #2
+++Sub-quote 2
+
++Quote #1
+++Sub-quote 1
+
++ ``` diff --git a/mkdocs.yml b/mkdocs.yml index 9951def..727eb4a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -34,4 +34,5 @@ nav: - Quickstart: quickstart.md - Compatibility: compatibility.md - Configuration: - - Showdown options: configuration.md \ No newline at end of file + - Showdown options: configuration.md + - Available options: available-options.md \ No newline at end of fileQuote #2
+++Sub-quote 2
+