Browse Source

Typo fixes and minor doc update

pull/14/head
Vitaly Puzrin 10 years ago
parent
commit
167bcd7940
  1. 16
      README.md
  2. 2
      demo/sample.md

16
README.md

@ -9,11 +9,8 @@ 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.
- Implements [CommonMark](http://commonmark.org/) spec + extentions: - Implements [CommonMark](http://commonmark.org/) spec + extentions
- strikeout (strikethrough, tables, URL autolinking, typographer).
- 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/)__
@ -130,12 +127,15 @@ md.typographer.set({
}) })
``` ```
Of cause, you can add your own rules or replace default one with something
more advanced, specific for your language.
### More extras ### More extras
This extentions are anabled by default This extentions are enabled by default:
- [Strike out](https://help.github.com/articles/github-flavored-markdown/#strikethrough) - [Strikethrough](https://help.github.com/articles/github-flavored-markdown/#strikethrough)
- [tables](https://help.github.com/articles/github-flavored-markdown/#tables) - [Tables](https://help.github.com/articles/github-flavored-markdown/#tables)
## References / Thanks ## References / Thanks

2
demo/sample.md

@ -54,7 +54,7 @@ __This is bold text__
_This is italic text_ _This is italic text_
~~Strike through this text.~~ ~~Strike through this text~~
## Blockquotes ## Blockquotes

Loading…
Cancel
Save