Browse Source

Docs update

pull/14/head
Vitaly Puzrin 10 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
md.typographer.set({
singleQuotes: '‘’',
doubleQuotes: '“”', // «» - russian, „“ - deutch
singleQuotes: '‘’', // set empty to disable
doubleQuotes: '“”', // set '«»' for russian, '„“' for deutch, empty to disable
copyright: true, // (c) (C) → ©
trademark: true, // (tm) (TM) → ™
registered: true, // (r) (R) → ®
@ -123,7 +123,7 @@ md.typographer.set({
paragraph: true, // (p) (P) -> §
ellipsis: true, // ... → … (also ?.... → ?.., !.... → !..)
dupes: true, // ???????? → ???, !!!!! → !!!, `,,``,`
emDashes: true // -- → —
dashes: true // -- → –, --- → —
})
```

38
demo/index.html

@ -154,38 +154,38 @@ _This is italic text_
## Blockquotes
> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.
Blockquotes can also be nested:
> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue.
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.
> Blockquotes can also be nested...
>> ...by using additional greater-than signs right next to each other...
> > > ...or with spaces between arrows.
## Lists
Unordered
+ Lorem ipsum dolor sit amet
+ Consectetur adipiscing elit
+ Integer molestie lorem at massa
- Phasellus iaculis neque
- Vestibulum laoreet porttitor sem
- Ac tristique libero volutpat at
* Facilisis in pretium nisl aliquet
* Nulla volutpat aliquam velit
+ Faucibus porta lacus fringilla vel
+ Create a list by starting a line with `+`, `-`, or `*`
+ Sub-lists are made by indenting 2 spaces:
- Marker character change forces new list start:
* Ac tristique libero volutpat at
+ Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
+ Very easy!
Ordered
1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit
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

8
demo/sample.md

@ -71,7 +71,7 @@ Unordered
+ Create a list by starting a line with `+`, `-`, or `*`
+ 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
+ Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
@ -83,9 +83,15 @@ Ordered
2. Consectetur adipiscing elit
3. Integer molestie lorem at massa
1. You can use sequential numbers...
1. ...or keep all the numbers as `1.`
Start numbering with offset:
57. foo
1. bar
## Code

4
lib/defaults/typographer.js

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

Loading…
Cancel
Save