codewalker/marked
1
0
Fork 0
Code Pull Requests Actions Packages Releases Activity

Add smart-lists to readme.

Browse Source
This commit is contained in:
Christopher Jeffrey 2013-01-17 09:29:56 -06:00
parent 84f6641a5c
commit 56b13a8c2d
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -72,6 +72,9 @@ marked has a few different switches which change behavior.
- __tables__: Enable GFM tables. This is enabled by default. (Requires the - __tables__: Enable GFM tables. This is enabled by default. (Requires the
`gfm` option in order to be enabled). `gfm` option in order to be enabled).
- __breaks__: Enable GFM line breaks. Disabled by default. - __breaks__: Enable GFM line breaks. Disabled by default.
- __smartLists__: Use smarter list behavior than the original markdown.
Disabled by default. May eventually be default with the old behavior
moved into `pedantic`.
## Usage ## Usage
@ -83,6 +86,7 @@ marked.setOptions({
breaks: false, breaks: false,
pedantic: false, pedantic: false,
sanitize: true, sanitize: true,
smartLists: true,
highlight: function(code, lang) { highlight: function(code, lang) {
if (lang === 'js') { if (lang === 'js') {
return highlighter.javascript(code); return highlighter.javascript(code);