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] 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