StarMirror/showdown
1
0
Fork 0
mirror of https://github.com/showdownjs/showdown.git synced 2024-03-22 13:30:55 +08:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Estevão Soares dos Santos 2015-07-15 11:15:39 +01:00
parent 932610839f
commit 107bdb7b2f
1 changed files with 21 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -182,13 +182,29 @@ var defaultOptions = showdown.getDefaultOptions();
```
* **headerLevelStart**: (integer) [default 1] Set the header starting level. For instance, setting this to 3 means that
`# foo` will be parsed as `<h3>foo</h3>`
* **simplifiedAutoLink**: (boolean) [default false] Turning this on will enable GFM autolink style. This means `some text www.google.com`
will be parsed as `<p>some text <a href="www.google.com">www.google.com</a>`
```md
# foo
```
will be parsed as
* **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:
```html
<h3>foo</h3>
```
* **simplifiedAutoLink**: (boolean) [default false] Turning this on will enable GFM autolink style. This means that
```md
some text www.google.com
```
will be parsed as
````
<p>some text <a href="www.google.com">www.google.com</a>
```
* **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:
```md
some text with__underscores__in middle