Browse Source

Docs update

pull/14/head
Vitaly Puzrin 11 years ago
parent
commit
cf1089e5ff
  1. 6
      README.md
  2. 38
      demo/index.html
  3. 8
      demo/sample.md
  4. 4
      lib/defaults/typographer.js

6
README.md

@ -114,8 +114,8 @@ var md = new Remarkable({ typographer: true });
// This values are default // This values are default
md.typographer.set({ md.typographer.set({
singleQuotes: '‘’', singleQuotes: '‘’', // set empty to disable
doubleQuotes: '“”', // «» - russian, „“ - deutch doubleQuotes: '“”', // set '«»' for russian, '„“' for deutch, empty to disable
copyright: true, // (c) (C) → © copyright: true, // (c) (C) → ©
trademark: true, // (tm) (TM) → ™ trademark: true, // (tm) (TM) → ™
registered: true, // (r) (R) → ® registered: true, // (r) (R) → ®
@ -123,7 +123,7 @@ md.typographer.set({
paragraph: true, // (p) (P) -> § paragraph: true, // (p) (P) -> §
ellipsis: true, // ... → … (also ?.... → ?.., !.... → !..) ellipsis: true, // ... → … (also ?.... → ?.., !.... → !..)
dupes: true, // ???????? → ???, !!!!! → !!!, `,,``,` dupes: true, // ???????? → ???, !!!!! → !!!, `,,``,`
emDashes: true // -- → — dashes: true // -- → –, --- → —
}) })
``` ```

38
demo/index.html

@ -154,38 +154,38 @@ _This is italic text_
## Blockquotes ## Blockquotes
> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.
Blockquotes can also be nested: > Blockquotes can also be nested...
>> ...by using additional greater-than signs right next to each other...
> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. > > > ...or with spaces between arrows.
Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
>> Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor
odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
>>> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue.
Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
## Lists ## Lists
Unordered Unordered
+ Lorem ipsum dolor sit amet + Create a list by starting a line with `+`, `-`, or `*`
+ Consectetur adipiscing elit + Sub-lists are made by indenting 2 spaces:
+ Integer molestie lorem at massa - Marker character change forces new list start:
- Phasellus iaculis neque * Ac tristique libero volutpat at
- Vestibulum laoreet porttitor sem + Facilisis in pretium nisl aliquet
- Ac tristique libero volutpat at - Nulla volutpat aliquam velit
* Facilisis in pretium nisl aliquet + Very easy!
* Nulla volutpat aliquam velit
+ Faucibus porta lacus fringilla vel
Ordered Ordered
1. Lorem ipsum dolor sit amet 1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit 2. Consectetur adipiscing elit
3. Integer molestie lorem at massa 3. Integer molestie lorem at massa
4. Facilisis in pretium nisl aliquet
1. You can use sequential numbers...
1. ...or keep all the numbers as `1.`
Start numbering with offset:
57. foo
1. bar
## Code ## Code

8
demo/sample.md

@ -71,7 +71,7 @@ Unordered
+ Create a list by starting a line with `+`, `-`, or `*` + Create a list by starting a line with `+`, `-`, or `*`
+ Sub-lists are made by indenting 2 spaces: + Sub-lists are made by indenting 2 spaces:
- You can also can mix symbols around with out any differance: - Marker character change forces new list start:
* Ac tristique libero volutpat at * Ac tristique libero volutpat at
+ Facilisis in pretium nisl aliquet + Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit - Nulla volutpat aliquam velit
@ -83,9 +83,15 @@ Ordered
2. Consectetur adipiscing elit 2. Consectetur adipiscing elit
3. Integer molestie lorem at massa 3. Integer molestie lorem at massa
1. You can use sequential numbers... 1. You can use sequential numbers...
1. ...or keep all the numbers as `1.` 1. ...or keep all the numbers as `1.`
Start numbering with offset:
57. foo
1. bar
## Code ## Code

4
lib/defaults/typographer.js

@ -4,8 +4,8 @@
module.exports = { module.exports = {
singleQuotes: '‘’', singleQuotes: '‘’', // set empty to disable
doubleQuotes: '“”', // «» - russian, „“ - deutch doubleQuotes: '“”', // set '«»' for russian, '„“' for deutch, empty to disable
copyright: true, // (c) (C) → © copyright: true, // (c) (C) → ©
trademark: true, // (tm) (TM) → ™ trademark: true, // (tm) (TM) → ™
registered: true, // (r) (R) → ® registered: true, // (r) (R) → ®

Loading…
Cancel
Save