Browse Source

Docs update

pull/14/head
Vitaly Puzrin 10 years ago
parent
commit
fca1de57ee
  1. 58
      README.md
  2. 10
      demo/assets/index.js
  3. 4
      demo/index.html
  4. 2
      demo/sample.js

58
README.md

@ -9,8 +9,8 @@ Markdown parser done right. Fast and easy to extend.
__[Live demo](http://jonschlinkert.github.io/remarkable/demo/)__ __[Live demo](http://jonschlinkert.github.io/remarkable/demo/)__
- 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 +
(strikethrough, tables, URL autolinking, typographer). [syntax extentions](#syntax-extentions) + sugar (URL autolinking, typographer).
- Very high speed. - Very high speed.
@ -37,7 +37,7 @@ CDNs for browser: [jsDeliver](http://www.jsdelivr.com/#!remarkable "jsDelivr CDN
var Remarkable = require('remarkable'); var Remarkable = require('remarkable');
// This values are default // This values are default
var md = new Remarkable({ var md = new Remarkable(/* "default" */, {
html: false, // Enable html tags in source html: false, // Enable html tags in source
xhtmlOut: false, // Use '/' to close single tags (<br />) xhtmlOut: false, // Use '/' to close single tags (<br />)
breaks: false, // Convert '\n' in paragraphs into <br> breaks: false, // Convert '\n' in paragraphs into <br>
@ -58,10 +58,10 @@ You can define options via `set` method:
```js ```js
var Remarkable = require('remarkable'); var Remarkable = require('remarkable');
var md = new Remarkable(); var md = new Remarkable('full');
md.set({ md.set({
html: false, html: true,
breaks: true breaks: true
}); });
``` ```
@ -70,13 +70,24 @@ __Note.__ To acheive best performance, don't modify the `Remarkable` instance on
the fly. If you need several configurations - create multiple instances and the fly. If you need several configurations - create multiple instances and
initialise each appropriately. initialise each appropriately.
You can also reset parser to strict [CommonMark](http://commonmark.org/) mode: Remarkable provides presets to quickly manage active syntax rules and options.
You can reset parser to strict [CommonMark](http://commonmark.org/) mode:
```js ```js
var Remarkable = require('remarkable'); var Remarkable = require('remarkable');
var md = new Remarkable('commonmark'); var md = new Remarkable('commonmark');
``` ```
Or you can enable everything:
```js
var Remarkable = require('remarkable');
var md = new Remarkable('full');
```
By default remarkable is configured to be similar to GFM, but with disabled HTML.
### Highligh fenced blocks ### Highligh fenced blocks
To highlight content of fenced block, assing function to `highlight` option: To highlight content of fenced block, assing function to `highlight` option:
@ -103,6 +114,34 @@ var md = new Remarkable({
}); });
``` ```
### Syntax extentions
Enabled by default:
- [Tables](https://help.github.com/articles/github-flavored-markdown/#tables) (GFM)
- [\<del>](https://help.github.com/articles/github-flavored-markdown/#strikethrough) (GFM strikethrough) - `~~deleted text~~`
Disabled by default:
- __\<ins>__ - `~~inserted text~~`
- __\<mark>__ - `==marked text==`
Manage rules:
```js
var md = new Remarkable();
md.inline.ruler.enable([ 'ins', 'mark' ]);
md.block.ruler.disable([ 'table' ]);
// Enable everything
md = new Remarkable('full', {
html: true,
linkify: true,
typographer: true,
});
```
### Typographer ### Typographer
Though full-weight typograpic replacements are language specific, `remarkable` Though full-weight typograpic replacements are language specific, `remarkable`
@ -130,13 +169,6 @@ md.typographer.set({
Of course, you can add your own rules or replace default ones with something Of course, you can add your own rules or replace default ones with something
more advanced, specific for your language. more advanced, specific for your language.
### More extras
These extensions are enabled by default:
- [Tables](https://help.github.com/articles/github-flavored-markdown/#tables) (GFM)
- [\<del>](https://help.github.com/articles/github-flavored-markdown/#strikethrough) (GFM strikethrough) - `~~deleted text~~`
## References / Thanks ## References / Thanks

10
demo/assets/index.js

@ -43,9 +43,13 @@
} }
function mdInit() { function mdInit() {
var opts = defaults._strict ? 'commonmark' : defaults; if (defaults._strict) {
mdHtml = new window.Remarkable(opts); mdHtml = new window.Remarkable('commonmark');
mdSrc = new window.Remarkable(opts); mdSrc = new window.Remarkable('commonmark');
} else {
mdHtml = new window.Remarkable('full', defaults);
mdSrc = new window.Remarkable('full', defaults);
}
// Beautify output of parser for html content // Beautify output of parser for html content
mdHtml.renderer.rules.table_open = function () { mdHtml.renderer.rules.table_open = function () {

4
demo/index.html

@ -152,6 +152,10 @@ _This is italic text_
~~Deleted text~~ ~~Deleted text~~
++Inserted text++
==Marked text==
## Blockquotes ## Blockquotes

2
demo/sample.js

@ -1,7 +1,7 @@
var Remarkable = require('remarkable'); var Remarkable = require('remarkable');
var hljs = require('highlight.js') // https://highlightjs.org/ var hljs = require('highlight.js') // https://highlightjs.org/
var md = new Remarkable({ var md = new Remarkable('full', {
html: false, // Enable html tags in source html: false, // Enable html tags in source
xhtmlOut: false, // Use '/' to close single tags (<br />) xhtmlOut: false, // Use '/' to close single tags (<br />)
breaks: false, // Convert '\n' in paragraphs into <br> breaks: false, // Convert '\n' in paragraphs into <br>

Loading…
Cancel
Save