Browse Source

Docs minor update

pull/14/head
Vitaly Puzrin 10 years ago
parent
commit
563f4b1bff
  1. 22
      README.md
  2. 16
      lib/defaults/typographer.js

22
README.md

@ -9,7 +9,11 @@ remarkable
Markdown parser done right. Fast and easy to extend. Markdown parser done right. Fast and easy to extend.
- Configurable syntax! You can add new rules and even replace existing ones. - 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. - Very high speed.
__[Live demo](http://jonschlinkert.github.io/remarkable/demo/)__ __[Live demo](http://jonschlinkert.github.io/remarkable/demo/)__
@ -77,7 +81,7 @@ var md = new Remarkable('commonmark');
### Typorgapher ### 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: provides the most common and universal case coverage:
```javascript ```javascript
@ -87,14 +91,14 @@ var md = new Remarkable({ typographer: true });
md.typographer.set({ md.typographer.set({
singleQuotes: '‘’', singleQuotes: '‘’',
doubleQuotes: '“”', // «» - russian, „“ - deutch doubleQuotes: '“”', // «» - russian, „“ - deutch
copyright: true, // (c) (C) -> © copyright: true, // (c) (C) ©
trademark: true, // (tm) (TM) -> trademark: true, // (tm) (TM)
registered: true, // (r) (R) -> ® registered: true, // (r) (R) ®
plusminus: true, // +- -> ± plusminus: true, // +- ±
paragraph: true, // (p) (P) -> § paragraph: true, // (p) (P) -> §
ellipsis: true, // ... -> ellipsis: true, // ...
dupes: true, // ???????? -> ???, !!!!! -> !!!, `,,` -> `,` dupes: true, // ???????? → ???, !!!!! → !!!, `,,` `,`
emDashes: true // -- -> emDashes: true // --
}) })
``` ```

16
lib/defaults/typographer.js

@ -6,12 +6,12 @@
module.exports = { module.exports = {
singleQuotes: '‘’', singleQuotes: '‘’',
doubleQuotes: '“”', // «» - russian, „“ - deutch doubleQuotes: '“”', // «» - russian, „“ - deutch
copyright: true, // (c) (C) -> © copyright: true, // (c) (C) ©
trademark: true, // (tm) (TM) -> trademark: true, // (tm) (TM)
registered: true, // (r) (R) -> ® registered: true, // (r) (R) ®
plusminus: true, // +- -> ± plusminus: true, // +- ±
paragraph: true, // (p) (P) -> § paragraph: true, // (p) (P) §
ellipsis: true, // ... -> ellipsis: true, // ...
dupes: true, // ???????? -> ???, !!!!! -> !!!, `,,` -> `,` dupes: true, // ???????? → ???, !!!!! → !!!, `,,` → `,`
emDashes: true // -- -> emDashes: true // --
}; };

Loading…
Cancel
Save