From d6c615f2680e79bbb76cc85a056aadfe3524513f Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Sat, 24 Jan 2015 11:07:01 -0800 Subject: Removed JS implementation, which is moving to its own repo: --- js/README.md | 132 ----------------------------------------------------------- 1 file changed, 132 deletions(-) delete mode 100644 js/README.md (limited to 'js/README.md') diff --git a/js/README.md b/js/README.md deleted file mode 100644 index c80ea9e..0000000 --- a/js/README.md +++ /dev/null @@ -1,132 +0,0 @@ -CommonMark -========== - -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`. - -For client-side use, you can do `make browserify` to produce -a standalone JavaScript file `js/dist/commonmark.js`, -suitable for linking into a web page, or just fetch -. - -To run tests for the JavaScript library: - - make testjs - -To run benchmarks against some other JavaScript converters: - - npm install showdown marked markdown-it - make benchjs - -To start an interactive dingus that you can use to try out -the library: - - make dingus - -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 emphasis into ALL CAPS. - -Here's a basic usage example: - - var reader = new commonmark.Parser(); - var writer = new commonmark.HtmlRenderer(); - var parsed = reader.parse("Hello *world*"); // parsed is a 'Node' tree - // transform parsed if you like... - var result = writer.render(parsed); // result is a string - - -- cgit v1.2.3