summaryrefslogtreecommitdiff
path: root/js/README.md
blob: 9f1e0433b83ced9d33966c86c2185e60ec6313ae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
CommonMark
==========

CommonMark is a rationalized version of Markdown syntax,
with a [spec][the spec] and BSD3-licensed reference
implementations in C and JavaScript.

For more information, see <http://commonmark.org>.

To play with this library without installing it, see
the live dingus at <http://spec.commonmark.org/dingus.html>.

This package includes the commonmark library and a
command-line executable, `commonmark`.

Basic usage example:

    var reader = new commonmark.DocParser();
    var writer = new commonmark.HtmlRenderer();
    var parsed = reader.parse("Hello *world*");
    var result = writer.render(parsed);

 [the spec]: http://spec.commonmark.org