diff options
| -rw-r--r-- | js/.npmignore | 3 | ||||
| -rw-r--r-- | js/README.md | 24 | ||||
| -rw-r--r-- | js/package.json | 27 |
3 files changed, 54 insertions, 0 deletions
diff --git a/js/.npmignore b/js/.npmignore new file mode 100644 index 0000000..d73e230 --- /dev/null +++ b/js/.npmignore @@ -0,0 +1,3 @@ +commonmark.js +*.tgz +index.html diff --git a/js/README.md b/js/README.md new file mode 100644 index 0000000..9f1e043 --- /dev/null +++ b/js/README.md @@ -0,0 +1,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 + diff --git a/js/package.json b/js/package.json new file mode 100644 index 0000000..4ae8bca --- /dev/null +++ b/js/package.json @@ -0,0 +1,27 @@ +{ "name": "commonmark", + "description": "a strongly specified, highly compatible variant of Markdown", + "dist-tags": { "latest": "0.9.0" }, + "versions": "0.9.0", + "homepage": "http://commonmark.org", + "keywords": + [ "markdown", + "commonmark", + "md", + "stmd" ], + "repository": + { "type": "git", + "url": "https://github.com/jgm/CommonMark.git" }, + "author": "John MacFarlane", + "bugs": { "url": "https://github.com/jgm/CommonMark/issues" }, + "license": "BSD-3-Clause", + "version": "0.9.0", + "main": "./lib/index.js", + "bin": { "commonmark": "./bin/commonmark" }, + "scripts": { "test": "node ./test.js" }, + "directories": { + "lib": "./lib" + }, + "engines": { + "node": "*" + } +} |