|
@@ -198,15 +198,17 @@ var defaultOptions = showdown.getDefaultOptions();
|
|
|
|
|
|
* **noHeaderId**: (boolean) [default false] Disable the automatic generation of header ids. Setting to true overrides **prefixHeaderId**
|
|
|
|
|
|
- * **customizedHeaderId**: (boolean) [default false] Use text in curly braces as header id. (since v1.7.0)
|
|
|
+ * **customizedHeaderId**: (boolean) [default false] Use text in curly braces as header id. **(since v1.7.0)**
|
|
|
Example:
|
|
|
```
|
|
|
## Sample header {real-id} will use real-id as id
|
|
|
```
|
|
|
|
|
|
- * **ghCompatibleHeaderId**: (boolean) [default false] Generate header ids compatible with github style (spaces are replaced with dashes and a bunch of non alphanumeric chars are removed) (since v1.5.5)
|
|
|
+ * **ghCompatibleHeaderId**: (boolean) [default false] Generate header ids compatible with github style (spaces are replaced with dashes and a bunch of non alphanumeric chars are removed) **(since v1.5.5)**
|
|
|
|
|
|
* **prefixHeaderId**: (string/boolean) [default false] Add a prefix to the generated header ids. Passing a string will prefix that string to the header id. Setting to `true` will add a generic 'section' prefix.
|
|
|
+
|
|
|
+ * **rawHeaderId**: (boolean) [default false] Remove only spaces, ' and " from generated header ids (including prefixes), replacing them with dashes (-). WARNING: This might result in malformed ids **(since v1.7.3)**
|
|
|
|
|
|
* **parseImgDimensions**: (boolean) [default false] Enable support for setting image dimensions from within markdown syntax.
|
|
|
Examples:
|
|
@@ -248,7 +250,8 @@ var defaultOptions = showdown.getDefaultOptions();
|
|
|
<p>check this link <a href="www.google.com">www.google.com</a>!</p>
|
|
|
```
|
|
|
|
|
|
- * **literalMidWordUnderscores**: (boolean) [default false] Turning this on will stop showdown from interpreting underscores in the middle of words as `<em>` and `<strong>` and instead treat them as literal underscores.
|
|
|
+ * **literalMidWordUnderscores**: (boolean) [default false] Turning this on will stop showdown from interpreting
|
|
|
+ underscores in the middle of words as `<em>` and `<strong>` and instead treat them as literal underscores.
|
|
|
|
|
|
Example:
|
|
|
|
|
@@ -260,7 +263,8 @@ var defaultOptions = showdown.getDefaultOptions();
|
|
|
<p>some text with__underscores__in middle</p>
|
|
|
```
|
|
|
|
|
|
- * **literalMidWordAsterisks**: (boolean) [default false] Turning this on will stop showdown from interpreting asterisks in the middle of words as `<em>` and `<strong>` and instead treat them as literal asterisks.
|
|
|
+ * **literalMidWordAsterisks**: (boolean) [default false] Turning this on will stop showdown from interpreting asterisks
|
|
|
+ in the middle of words as `<em>` and `<strong>` and instead treat them as literal asterisks.
|
|
|
|
|
|
Example:
|
|
|
|
|
@@ -301,9 +305,9 @@ var defaultOptions = showdown.getDefaultOptions();
|
|
|
* **smartIndentationFix**: (boolean) [default false] Tries to smartly fix indentation problems related to es6 template strings in the midst of indented code.
|
|
|
|
|
|
* **disableForced4SpacesIndentedSublists**: (boolean) [default false] Disables the requirement of indenting sublists by 4 spaces for them to be nested,
|
|
|
- effectively reverting to the old behavior where 2 or 3 spaces were enough. (since v1.5.0)
|
|
|
+ effectively reverting to the old behavior where 2 or 3 spaces were enough. **(since v1.5.0)**
|
|
|
|
|
|
- * **simpleLineBreaks**: (boolean) [default false] Parses line breaks as <br> like GitHub does, without needing 2 spaces at the end of the line (since v1.5.1)
|
|
|
+ * **simpleLineBreaks**: (boolean) [default false] Parses line breaks as <br> like GitHub does, without needing 2 spaces at the end of the line **(since v1.5.1)**
|
|
|
|
|
|
```md
|
|
|
a line
|
|
@@ -317,9 +321,9 @@ var defaultOptions = showdown.getDefaultOptions();
|
|
|
wrapped in two</p>
|
|
|
```
|
|
|
|
|
|
- * **requireSpaceBeforeHeadingText**: (boolean) [default false] Makes adding a space between `#` and the header text mandatory (since v1.5.3)
|
|
|
+ * **requireSpaceBeforeHeadingText**: (boolean) [default false] Makes adding a space between `#` and the header text mandatory **(since v1.5.3)**
|
|
|
|
|
|
- * **ghMentions**: (boolean) [default false] Enables github @mentions, which link to the username mentioned (since v1.6.0)
|
|
|
+ * **ghMentions**: (boolean) [default false] Enables github @mentions, which link to the username mentioned **(since v1.6.0)**
|
|
|
|
|
|
* **ghMentionsLink**: (string) [default `https://github.com/{u}`] Changes the link generated by @mentions. Showdown will replace `{u}` with the username. Only applies if ghMentions option is enabled.
|
|
|
Example: `@tivie` with ghMentionsOption set to `//mysite.com/{u}/profile` will result in `<a href="//mysite.com/tivie/profile">@tivie</a>`
|
|
@@ -328,11 +332,11 @@ var defaultOptions = showdown.getDefaultOptions();
|
|
|
|
|
|
NOTE: Prior to version 1.6.1, emails would always be obfuscated through dec and hex encoding.
|
|
|
|
|
|
- * **openLinksInNewWindow**: (boolean) [default false] Open all links in new windows (by adding the attribute `target="_blank"` to `<a>` tags) (since v1.7.0)
|
|
|
+ * **openLinksInNewWindow**: (boolean) [default false] Open all links in new windows (by adding the attribute `target="_blank"` to `<a>` tags) **(since v1.7.0)**
|
|
|
|
|
|
- * **backslashEscapesHTMLTags**: (boolean) [default false] Support for HTML Tag escaping. ex: `\<div>foo\</div>` (since v1.7.2)
|
|
|
+ * **backslashEscapesHTMLTags**: (boolean) [default false] Support for HTML Tag escaping. ex: `\<div>foo\</div>` **(since v1.7.2)**
|
|
|
|
|
|
-**NOTE**: Please note that until version 1.6.0, all of these options are ***DISABLED*** by default in the cli tool.
|
|
|
+**NOTE**: Please note that until **version 1.6.0**, all of these options are ***DISABLED*** by default in the cli tool.
|
|
|
|
|
|
## Flavors
|
|
|
|