From 9a1291b4d751d8533a56911d41b2596fa95eaf85 Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Thu, 15 Jan 2015 22:02:27 -0800 Subject: Improved js README.md. Still much to do. --- js/README.md | 36 ++++++++++++++++++++++++++++++++---- 1 file changed, 32 insertions(+), 4 deletions(-) (limited to 'js') diff --git a/js/README.md b/js/README.md index 9f1e043..6803754 100644 --- a/js/README.md +++ b/js/README.md @@ -5,20 +5,48 @@ CommonMark is a rationalized version of Markdown syntax, with a [spec][the spec] and BSD3-licensed reference implementations in C and JavaScript. + [the spec]: http://spec.commonmark.org + For more information, see . To play with this library without installing it, see the live dingus at . +Installing +---------- + +You can install the library using `npm`: + + npm install commonmark + This package includes the commonmark library and a command-line executable, `commonmark`. -Basic usage example: +For client-side use, you can do `make browserify` to produce +a standalone JavaScript file `js/commonmark.js`, +suitable for linking into a web page, or just fetch +. + +Usage +----- + +Instead of converting Markdown directly to HTML, as most converters +do, `commonmark.js` parses Markdown to an AST (abstract syntax tree), +and then renders this AST as HTML. This opens up the possibility of +manipulating the AST between parsing and rendering. For example, one +could transform all emphasis into ALL CAPS. + +Here's a basic usage example: var reader = new commonmark.DocParser(); var writer = new commonmark.HtmlRenderer(); - var parsed = reader.parse("Hello *world*"); - var result = writer.render(parsed); + var parsed = reader.parse("Hello *world*"); // parsed is a 'Node' tree + var result = writer.render(parsed); // result is a string + + -- cgit v1.2.3