From b88bdbedc8c2b45bae8bff4d9dec1aaaff72190b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Estev=C3=A3o=20Soares=20dos=20Santos?= Date: Tue, 14 Jul 2015 21:47:02 +0100 Subject: [PATCH 1/6] docs(README.md): add reference to option smoothLivePreview --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 49030c0..33dd7aa 100644 --- a/README.md +++ b/README.md @@ -221,6 +221,7 @@ var defaultOptions = showdown.getDefaultOptions(); - [x] This task is done - [ ] This is still pending ``` + * **smoothLivePreview**: (boolean) [default false] Prevents weird effects in live previews due to incomplete input ## CLI Tool From e5f886b67087c47858a36536a139577cb327e2d9 Mon Sep 17 00:00:00 2001 From: Dipesh Date: Wed, 15 Jul 2015 11:45:54 +0530 Subject: [PATCH 2/6] Updated readme.md in Example of Setting options -> Locally, While creating showdown.Converter object closing '}' is missing --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 33dd7aa..6faa7c0 100644 --- a/README.md +++ b/README.md @@ -117,7 +117,7 @@ Local options can be set: * **through the constructor** ```js - var converter = new showdown.Converter({optionKey: 'value'); + var converter = new showdown.Converter({optionKey: 'value'}); ``` * **through the setOption() method** From 107bdb7b2f3ad06886583e943266f15420b33e3b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Estev=C3=A3o=20Soares=20dos=20Santos?= Date: Wed, 15 Jul 2015 11:15:39 +0100 Subject: [PATCH 3/6] Update README.md --- README.md | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6faa7c0..fb4436a 100644 --- a/README.md +++ b/README.md @@ -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 `

foo

` - * **simplifiedAutoLink**: (boolean) [default false] Turning this on will enable GFM autolink style. This means `some text www.google.com` - will be parsed as `

some text www.google.com` + ```md + # foo + ``` + will be parsed as + + ```html +

foo

+ ``` + + * **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 + ```` +

some text www.google.com + ``` - * **literalMidWordUnderscores**: (boolean) [default false] Turning this on will stop showdown from interpreting underscores - in the middle of words as `` and `` and instead treat them as literal underscores. Example: + * **literalMidWordUnderscores**: (boolean) [default false] Turning this on will stop showdown from interpreting underscores in the middle of words as `` and `` and instead treat them as literal underscores. + + Example: ```md some text with__underscores__in middle From 1ebb08484d24abd9d10d53eae95c89b06093ac2a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Estev=C3=A3o=20Soares=20dos=20Santos?= Date: Thu, 16 Jul 2015 20:55:55 +0100 Subject: [PATCH 4/6] docs(README.md): add examples to image dimensions --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fb4436a..27f79f9 100644 --- a/README.md +++ b/README.md @@ -176,9 +176,11 @@ var defaultOptions = showdown.getDefaultOptions(); * **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. * **parseImgDimensions**: (boolean) [default false] Enable support for setting image dimensions from within markdown syntax. - Example: + Examples: ``` - ![my image](foo.jpg =100x80) + ![foo](foo.jpg =100x80) simple, assumes units are in px + ![bar](bar.jpg =100x*) sets the height to "auto" + ![baz](baz.jpg =80%x5em*) Image with width of 80% and height of 5em ``` * **headerLevelStart**: (integer) [default 1] Set the header starting level. For instance, setting this to 3 means that From a3b5946ec91f27dd7d1c178223c4f819cae1be5c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Estev=C3=A3o=20Soares=20dos=20Santos?= Date: Tue, 21 Jul 2015 13:42:15 +0100 Subject: [PATCH 5/6] docs(README.md): change table example --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 27f79f9..7e7cd6a 100644 --- a/README.md +++ b/README.md @@ -222,9 +222,10 @@ var defaultOptions = showdown.getDefaultOptions(); * **tables**: (boolean) [default false] Enable support for tables syntax. Example: ```md - | *foo* | **bar** | ~~baz~~ | + | h1 | h2 | h3 | |:------|:-------:|--------:| | 100 | [a][1] | ![b][2] | + | *foo* | **bar** | ~~baz~~ | ``` See the wiki for more info From bf4798a728ff62a7e6e80acf30d2df3194cb0766 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Estev=C3=A3o=20Soares=20dos=20Santos?= Date: Tue, 21 Jul 2015 21:01:47 +0100 Subject: [PATCH 6/6] docs(README.md): fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7e7cd6a..8cd2f79 100644 --- a/README.md +++ b/README.md @@ -180,7 +180,7 @@ var defaultOptions = showdown.getDefaultOptions(); ``` ![foo](foo.jpg =100x80) simple, assumes units are in px ![bar](bar.jpg =100x*) sets the height to "auto" - ![baz](baz.jpg =80%x5em*) Image with width of 80% and height of 5em + ![baz](baz.jpg =80%x5em) Image with width of 80% and height of 5em ``` * **headerLevelStart**: (integer) [default 1] Set the header starting level. For instance, setting this to 3 means that