codewalker/marked
1
0
Fork 0
Code Pull Requests Actions Packages Releases Activity

readme, benchmarks, version

Browse Source
This commit is contained in:
Christopher Jeffrey 2011-10-22 09:16:14 -05:00
parent 25e75a5735
commit 9d370fb8c3
2 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -1,15 +1,16 @@
# marked # marked
A full-featured markdown parser and compiler implemented in ~430 lines of JS. A full-featured markdown parser and compiler implemented in ~430 lines of JS.
Built for speed. Built for speed.
## Benchmarks ## Benchmarks
``` bash ``` bash
$ node test --bench $ node test --bench
marked completed in 15051ms. marked completed in 12071ms.
showdown completed in 28267ms. showdown (reuse converter) completed in 27387ms.
markdown-js completed in 70732ms. showdown (new converter) completed in 75617ms.
markdown-js completed in 70069ms.
``` ```
## Install ## Install
@ -20,19 +21,19 @@ $ npm install marked
# Another javascript markdown parser # Another javascript markdown parser
The point of marked was to create a markdown compiler where it was possible to The point of marked was to create a markdown compiler where it was possible to
frequently parse huge chunks of markdown without having to worry about frequently parse huge chunks of markdown without having to worry about
caching the compiled output somehow...or blocking for an unnecesarily long time. caching the compiled output somehow...or blocking for an unnecesarily long time.
marked lingers around 430 (may vary) lines long and still implements all marked lingers around 430 (may vary) lines long and still implements all
markdown features. It is also now fully compatible with the client-side. markdown features. It is also now fully compatible with the client-side.
marked more or less passes the official markdown test suite in its marked more or less passes the official markdown test suite in its
entirety. This is important because a surprising number of markdown compilers entirety. This is important because a surprising number of markdown compilers
cannot pass more than a few tests. It was very difficult to get marked as cannot pass more than a few tests. It was very difficult to get marked as
compliant as it is. It could have cut corners in several areas for the sake compliant as it is. It could have cut corners in several areas for the sake
of performance, but did not in order to be exactly what you expect in terms of performance, but did not in order to be exactly what you expect in terms
of a markdown rendering. In fact, this is why marked could be considered at a of a markdown rendering. In fact, this is why marked could be considered at a
disadvantage in the benchmarks above. disadvantage in the benchmarks above.
## Usage ## Usage
@ -61,8 +62,8 @@ $ node
## Todo (& notes to self) ## Todo (& notes to self)
- Implement GFM features. - Implement GFM features.
- Possibly add some - Possibly add some
[ReMarkable](http://camendesign.com/code/remarkable/documentation.html) [ReMarkable](http://camendesign.com/code/remarkable/documentation.html)
features while remaining backwardly compatible with all markdown syntax. features while remaining backwardly compatible with all markdown syntax.
- Optimize the lexer to return an iterator instead of a collection of tokens. - Optimize the lexer to return an iterator instead of a collection of tokens.
- Add an explicit pretty printing and minification feature. - Add an explicit pretty printing and minification feature.

2
package.json
View File

@ -2,7 +2,7 @@
"name": "marked", "name": "marked",
"description": "A markdown parser built for speed", "description": "A markdown parser built for speed",
"author": "Christopher Jeffrey", "author": "Christopher Jeffrey",
"version": "0.1.1", "version": "0.1.2",
"main": "./lib/marked.js", "main": "./lib/marked.js",
"bin": { "marked": "./bin/marked" }, "bin": { "marked": "./bin/marked" },
"repository": "git://github.com/chjj/marked.git", "repository": "git://github.com/chjj/marked.git",