From 563f4b1bffb5fa3add936da8a57c79a31da51187 Mon Sep 17 00:00:00 2001 From: Vitaly Puzrin Date: Fri, 10 Oct 2014 18:57:55 +0400 Subject: [PATCH] Docs minor update --- README.md | 22 +++++++++++++--------- lib/defaults/typographer.js | 16 ++++++++-------- 2 files changed, 21 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 1275a6f..158ec32 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,11 @@ remarkable Markdown parser done right. Fast and easy to extend. - Configurable syntax! You can add new rules and even replace existing ones. -- Support [CommonMark](http://commonmark.org/) spec. +- Implements [CommonMark](http://commonmark.org/) spec + extentions: + - strikeout + - tables + - linkify (autoconvert links from text) + - typographer - Very high speed. __[Live demo](http://jonschlinkert.github.io/remarkable/demo/)__ @@ -77,7 +81,7 @@ var md = new Remarkable('commonmark'); ### Typorgapher -Though full weigh typograpic replacements are language specific, `remarkabple` +Though full weigh typograpic replacements are language specific, `remarkable` provides the most common and universal case coverage: ```javascript @@ -87,14 +91,14 @@ var md = new Remarkable({ typographer: true }); md.typographer.set({ singleQuotes: '‘’', doubleQuotes: '“”', // «» - russian, „“ - deutch - copyright: true, // (c) (C) -> © - trademark: true, // (tm) (TM) -> ™ - registered: true, // (r) (R) -> ® - plusminus: true, // +- -> ± + copyright: true, // (c) (C) → © + trademark: true, // (tm) (TM) → ™ + registered: true, // (r) (R) → ® + plusminus: true, // +- → ± paragraph: true, // (p) (P) -> § - ellipsis: true, // ... -> … - dupes: true, // ???????? -> ???, !!!!! -> !!!, `,,` -> `,` - emDashes: true // -- -> — + ellipsis: true, // ... → … + dupes: true, // ???????? → ???, !!!!! → !!!, `,,` → `,` + emDashes: true // -- → — }) ``` diff --git a/lib/defaults/typographer.js b/lib/defaults/typographer.js index 3d637d4..8885f3c 100644 --- a/lib/defaults/typographer.js +++ b/lib/defaults/typographer.js @@ -6,12 +6,12 @@ module.exports = { singleQuotes: '‘’', doubleQuotes: '“”', // «» - russian, „“ - deutch - copyright: true, // (c) (C) -> © - trademark: true, // (tm) (TM) -> ™ - registered: true, // (r) (R) -> ® - plusminus: true, // +- -> ± - paragraph: true, // (p) (P) -> § - ellipsis: true, // ... -> … - dupes: true, // ???????? -> ???, !!!!! -> !!!, `,,` -> `,` - emDashes: true // -- -> — + copyright: true, // (c) (C) → © + trademark: true, // (tm) (TM) → ™ + registered: true, // (r) (R) → ® + plusminus: true, // +- → ± + paragraph: true, // (p) (P) → § + ellipsis: true, // ... → … + dupes: true, // ???????? → ???, !!!!! → !!!, `,,` → `,` + emDashes: true // -- → — };