Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions. (**NOT YET SUPPORTED**)\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Christopher Jeffrey. (MIT License)\n\nSee LICENSE for more info.\n","_id":"namp@0.2.0","dist":{"shasum":"7aaf02d6aac265deb91dda896e86fabddb492c7b","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.0.tgz","integrity":"sha512-rWvyav9bj9Jp9sxWwU5wXrch+KCGssm+Zo4jPGJu80Lqaldbf/qWtSL8na8zqrGmbWvnylkW/I3GPS9nJ0BINA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBDcFbYrNAHJwp4ZvJ1r5DUrR6cYCPKKggvigGeo+v8KAiAXwRqnmAw8abxhbUBe7KjYN6TJTOhr4mpm0DpuyJa5Vg=="}]},"directories":{}},"0.2.1":{"name":"namp","version":"0.2.1","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","bin":{"namp":"./bin/namp"},"man":["./man/marked.1"],"dependencies":{"highlight.js":"~1.0.4"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions. (**NOT YET SUPPORTED**)\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Christopher Jeffrey. (MIT License)\n\nSee LICENSE for more info.\n","_id":"namp@0.2.1","dist":{"shasum":"eeb25cdb8a6dbcb577e353ce524a6cc604770a75","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.1.tgz","integrity":"sha512-fQfqrxbOR5pa79E0X7tGJFKqCy1Gx8tq7ZXJWuVDjOAC+xq5pSJpQq/Jc27H9FhOyz+6mMQBYoYlNFYl/VQJlw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGR5aKt7V7Z54/JVQ4BRkqZJDiF1FwTMb3yGXs+48A5NAiBJAn5sneehqPlscVYFuGB9uICxZ13mCK+VaYmsFZVcbQ=="}]},"directories":{}},"0.2.2":{"name":"namp","version":"0.2.2","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","bin":{"namp":"./bin/namp"},"man":["./man/marked.1"],"dependencies":{"highlight.js":"~1.0.4"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions. (**NOT YET SUPPORTED**)\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Christopher Jeffrey. (MIT License)\n\nSee LICENSE for more info.\n","_id":"namp@0.2.2","dist":{"shasum":"3a13f1d34fc4019021f59a28ea6c25034a446aac","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.2.tgz","integrity":"sha512-4hAYXlwRF5McK2tl2dsW9HjzW8XGvfU7BG51fRf127u6RyuvTJBXytEYQeI6jdHcXQRCrz9uBSMGkCPSyAcySQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDU03qADwcSTlWY6M/Yx7d+H8AJ6e0aK48FKMj+KsurMwIgKXHw0gx3x3ilQzQYGbxBZPTjPjmx/cjFSaUmi+SqCJw="}]},"directories":{}},"0.2.3":{"name":"namp","version":"0.2.3","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","bin":{"namp":"./bin/namp"},"man":["./man/marked.1"],"dependencies":{"highlight.js":"~1.0.4"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions. (**NOT YET SUPPORTED**)\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Christopher Jeffrey. (MIT License)\n\nSee LICENSE for more info.\n","_id":"namp@0.2.3","dist":{"shasum":"bf4c1822a90a0b42ae1ec0b20031c4ca9028a1ce","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.3.tgz","integrity":"sha512-6dHRZIVuuisSUjsAW5+ys0f8WxkOIWN7lLDJe89wow4+H+KHAhHugsHzF19uN4VwM6gmqhuQytP5lJ4UkUrJ5w==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDZld4CjjlUMp0NCC58qKJqIIxViV/fd7v10us4MxfzgAiEAo5u/30LHwoMv1909FdgomV3jTiiIzj06zoKbGaIiAGc="}]},"directories":{}},"0.2.4":{"name":"namp","version":"0.2.4","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","bin":{"namp":"./bin/namp"},"man":["./man/marked.1"],"dependencies":{"highlight.js":">=7.0.0"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions. (**NOT YET SUPPORTED**)\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Christopher Jeffrey. (MIT License)\n\nSee LICENSE for more info.\n","_id":"namp@0.2.4","dist":{"shasum":"14962ef4c05d6b59750b1e20397dde99001459af","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.4.tgz","integrity":"sha512-hej5lVIYnhz12Hf/aTiomQoRKUjZ660sCoULsZ1qzMvk6M4NAcD84vQ0KlDar/WV1v8tJPKVzuH0+QBvq8Eiqg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCFP9WKXNTkr7rvkxi46OqhOnFUTUNt6/ODtqdin9GV5gIgZ1rbdnZHU0NWpO/S0QonXbqCR3ttlIINcPtqP5XreaE="}]},"directories":{}},"0.2.5":{"name":"namp","version":"0.2.5","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","bin":{"namp":"./bin/namp"},"man":["./man/marked.1"],"dependencies":{"highlight.js":">=7.0.0"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions. (**NOT YET SUPPORTED**)\n\n* Markdown wrapped in `` is processed.\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Garen Torikian. (MIT License)\n\nSee LICENSE for more info.\n\nBased mostly on Christopher Jeffrey (https://github.com/chjj/)\n","_id":"namp@0.2.5","dist":{"shasum":"962c8268b6caeb8fb6d1dc95550f17523dc46e40","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.5.tgz","integrity":"sha512-rNu+Wl/lwGDWE2ozO0NHy6tdTQ2Nge15aJ3vp2fMAP1ZQJKgb1dLFJ2KZU+WBDrpeqIi6/gSmKsAbQNcgYi2Kw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHhIbX5O9XSoDi5hGbY8gj9eDJKTwhj2d3t2przCXsxBAiBOxN0lNPAbgo1WwnmK5BJJzv0EdmM96IoAxxnv1GD1Gw=="}]},"directories":{}},"0.2.6":{"name":"namp","version":"0.2.6","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","bin":{"namp":"./bin/namp"},"man":["./man/marked.1"],"dependencies":{"highlight.js":">=7.0.0"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions. (**NOT YET SUPPORTED**)\n\n* Markdown wrapped in `` is processed.\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Garen Torikian. (MIT License)\n\nSee LICENSE for more info.\n\nBased mostly on Christopher Jeffrey (https://github.com/chjj/)\n","_id":"namp@0.2.6","dist":{"shasum":"e007008a2847ca61abad4689c1e68a7b8850ff55","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.6.tgz","integrity":"sha512-S5Ta6Uh0QBj5KPsQgDbitPAry/sBIa8x5lIeVOFomhbm8vDfX+UQ8bhtqgP6pYfiu0xo46GBt9AR382DTuwytQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFYnitkhRF5uwWg+XN4voCBVDaTqKWOn3+fJVIS9tYcCAiEAqDcEKEaeuuFyiDJjtsWaE5Lh0ls5ev0TxVXyaca8ugY="}]},"directories":{}},"0.2.8":{"name":"namp","version":"0.2.8","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","bin":{"namp":"./bin/namp"},"man":["./man/marked.1"],"dependencies":{"highlight.js":">=7.0.0"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions. (**NOT YET SUPPORTED**)\n\n* Markdown wrapped in `` is processed.\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Garen Torikian. (MIT License)\n\nSee LICENSE for more info.\n\nBased mostly on Christopher Jeffrey (https://github.com/chjj/)\n","_id":"namp@0.2.8","dist":{"shasum":"5427c41757d36aabe42133fbb8d16ca04ac7c677","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.8.tgz","integrity":"sha512-iBXQ8N7uAGtcscSw3KRrrazmc6X1A2ieEY3EXz1Wa8vV1K2oiIFR/CU6eLlRKikI01TdJ5OR2m1EL8IEpCdVqQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBOaZoM9yFX6EJGdthmuCJP7hiJ60w0lfH2FI255u7K9AiB3oxgr5i0BthObduKDcOLDfqI6jazcD64JXKj4C/iH3Q=="}]},"directories":{}},"0.2.9":{"name":"namp","version":"0.2.9","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","bin":{"namp":"./bin/namp"},"man":["./man/marked.1"],"dependencies":{"highlight.js":">=7.0.0"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions. (**NOT YET SUPPORTED**)\n\n* Markdown wrapped in `` is processed.\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Garen Torikian. (MIT License)\n\nSee LICENSE for more info.\n\nBased mostly on Christopher Jeffrey (https://github.com/chjj/)\n","_id":"namp@0.2.9","dist":{"shasum":"5e44316d1ece32710bece0b5c9394f3132d73b82","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.9.tgz","integrity":"sha512-NKstB+jS1j9K/r4LXuT6zsv+nWyvKaOL6IB3UVkVg9WvG/AAfft5o3lvitDupuVOp6eBMoMoUkzk/YfJ8ZtOkA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDD7R+/StmxeAbjCAAQmFUfRUJsRy03Uk+6yeUu7T/geAiEA43v57d1BJrLHDmrHFRKZXF+jblmxb8SNeFQVhckees0="}]},"directories":{}},"0.2.10":{"name":"namp","version":"0.2.10","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","bin":{"namp":"./bin/namp"},"man":["./man/marked.1"],"dependencies":{"highlight.js":">=7.0.0"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions. (**NOT YET SUPPORTED**)\n\n* Markdown wrapped in `` is processed.\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Garen Torikian. (MIT License)\n\nSee LICENSE for more info.\n\nBased mostly on Christopher Jeffrey (https://github.com/chjj/)\n","_id":"namp@0.2.10","dist":{"shasum":"71bb5e2b23cd13176e0224d36e80c1827cefecfd","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.10.tgz","integrity":"sha512-EFR+ry8qWFUqnZ/qn5dYe7J6RKdYD+h8wWbDtNjprBpMJce8+llFWjcyaI6fkCPyulhTBMtptXx2Qu+DCw6g3w==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHYYHxlo4rQvasBuoEGs2trXpgaxqIlzVe0jPypMkETeAiAlT0nfUVzSNLJmo6R1//Bf2FyFHZMbrb6UWIwSpJ++OQ=="}]},"directories":{}},"0.2.11":{"name":"namp","version":"0.2.11","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","bin":{"namp":"./bin/namp"},"man":["./man/marked.1"],"dependencies":{"highlight.js":">=7.0.0"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions.\n* `[[keys: ]]` converts keyboard characters into a pretty-printed format\n* `[[menu: ]]` converts a comma-seprated list into a pretty-printed menu\n* Markdown wrapped in `` is processed.\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Garen Torikian. (MIT License)\n\nSee LICENSE for more info.\n\nBased mostly on Christopher Jeffrey (https://github.com/chjj/)\n","_id":"namp@0.2.11","dist":{"shasum":"e442795cb53bb4e0d2cd5ebd7600cb186e4b67e3","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.11.tgz","integrity":"sha512-3KPaVJXYhZ//1q4xq9ib/LSt6XpZk4J+ynGGT2qjt4t59bfabV2pd0rI0KGDaxYsak1TDa36pGauKlJ1A2WT8Q==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIE55dLoG4o+2NazjYrmCjzi/uDx85Z/X83TrtMc6iEJKAiEA9sFrRh5d9buaj3mLAc4boFafsh57RnWJPigvXGa5z5w="}]},"directories":{}},"0.2.12":{"name":"namp","version":"0.2.12","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","bin":{"namp":"./bin/namp"},"man":["./man/marked.1"],"dependencies":{"highlight.js":">=7.0.0"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions.\n* `[[keys: ]]` converts keyboard characters into a pretty-printed format\n* `[[menu: ]]` converts a comma-seprated list into a pretty-printed menu\n* Markdown wrapped in `` is processed.\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Garen Torikian. (MIT License)\n\nSee LICENSE for more info.\n\nBased mostly on Christopher Jeffrey (https://github.com/chjj/)\n","_id":"namp@0.2.12","dist":{"shasum":"8714bbb9cfd611c833818c478f6f2bbf3cbf75f3","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.12.tgz","integrity":"sha512-4hstomOJG8wl26Wh5p4nOTVww54oLRROXj+WpUBD0B6n+8gY1BNsgbcBazAiD7feTr9pn3ja8M/MaVvzfhTheQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCPFGHunh5+corzMuD1v1K81ejURYpeJt/KvwQibVO41QIhAJy1o2pY06/E4tNf0xVxIb9j43LdPpx/T/S3ULA6GER8"}]},"directories":{}},"0.2.13":{"name":"namp","version":"0.2.13","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","bin":{"namp":"./bin/namp"},"man":["./man/marked.1"],"dependencies":{"highlight.js":">=7.0.0"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions.\n* `[[keys: ]]` converts keyboard characters into a pretty-printed format\n* `[[menu: ]]` converts a comma-seprated list into a pretty-printed menu\n* Markdown wrapped in `` is processed.\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Garen Torikian. (MIT License)\n\nSee LICENSE for more info.\n\nBased mostly on Christopher Jeffrey (https://github.com/chjj/)\n","_id":"namp@0.2.13","dist":{"shasum":"ec03b8b2cde140c75a28cfb94e95a36bf2da6bbf","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.13.tgz","integrity":"sha512-YMj0HZtX9ayXxy8tXfkSexW1SweFiO/hKf6rd/4lintyR39onFuJFrcxbpA45hbn4Byt7z8uZBBjiIz8Zqq7Jg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAiRJeItkE/kmL8p6F5QHDhzygxGtjKlIxlctvNRtsl3AiEAw5ilWJTDtjBGJ56hdHmqR6wMhd6oJObjGCYKqNfDSzw="}]},"directories":{}},"0.2.14":{"name":"namp","version":"0.2.14","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more. Based on marked.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","dependencies":{"highlight.js":">=7.0.0"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions.\n* `[[keys: ]]` converts keyboard characters into a pretty-printed format\n* `[[menu: ]]` converts a comma-seprated list into a pretty-printed menu\n* Markdown wrapped in `` is processed.\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Garen Torikian. (MIT License)\n\nSee LICENSE for more info.\n\nBased mostly on Christopher Jeffrey (https://github.com/chjj/)\n","_id":"namp@0.2.14","dist":{"shasum":"11a99a3f545cc3d4d85e8004474d2e94935fb13d","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.14.tgz","integrity":"sha512-orW3LSIUV074ylAxGcsgJ/xPwyt9u27tmBiKpQFTE8rqgBNM3DJ4HLwYOkzPnywypSfriRUF+ZfksG9p3+/dIw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCMtL2EYLnO63fs1IWfrAQDQgDSYb/KvXcQaE1+gW4dQQIgGMMNADMe2MxuOYv2C7OKhkbTfY3NwyMTz4D/U3YWsE4="}]},"directories":{}},"0.2.15":{"name":"namp","version":"0.2.15","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more. Based on marked.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","dependencies":{"highlight.js":">=7.0.0"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions.\n* `[[keys: ]]` converts keyboard characters into a pretty-printed format\n* `[[menu: ]]` converts a comma-seprated list into a pretty-printed menu\n* Markdown wrapped in `` is processed.\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Garen Torikian. (MIT License)\n\nSee LICENSE for more info.\n\nBased mostly on Christopher Jeffrey (https://github.com/chjj/)\n","_id":"namp@0.2.15","dist":{"shasum":"43008ca83da70b9ed7f3631e953b80badcf4e61a","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.15.tgz","integrity":"sha512-oa79sd8EYfOh5hmF6/StAPg3tAT4MHX4sVwu++CoGf82v2hgVSN0IrkesgSAyaOWxwtzL6q9hBZWIOyXyVjsaw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCJLzUvZyirYIWxbMSAgoRHoilrNLd++8JCy4onrkD+8gIgXDTvFP1BBlAIjqogYxp4NWySRthHnY4p4InZ+cWf3i8="}]},"directories":{}},"0.2.16":{"name":"namp","version":"0.2.16","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more. Based on marked.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","dependencies":{"highlight.js":">=7.0.0"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions.\n* `[[keys: ]]` converts keyboard characters into a pretty-printed format\n* `[[menu: ]]` converts a comma-seprated list into a pretty-printed menu\n* Markdown wrapped in `` is processed.\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Garen Torikian. (MIT License)\n\nSee LICENSE for more info.\n\nBased mostly on Christopher Jeffrey (https://github.com/chjj/)\n","_id":"namp@0.2.16","dist":{"shasum":"fa9ab6d973797f635c7e62a84892d5f664509e4c","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.16.tgz","integrity":"sha512-HExo7MqN4rHZBYWBXxmfdhZSCbOO/mrdG0LMTCtu/sam9ehHXALqDWqWjcypwNTPORTkXEwPoV/FsumgDomRyQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCw1vmUrFJ1GF+emMbkUAJXCMBqMqF8HpJ/sFh+YQvQPgIhAJ7S5VfSNPPItGsDb3Jl0UJ0lyRwVR1B2Ckd17ryk5mk"}]},"directories":{}},"0.2.17":{"name":"namp","version":"0.2.17","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more. Based on marked.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","dependencies":{"highlight.js":">=7.0.0"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions.\n* `[[keys: ]]` converts keyboard characters into a pretty-printed format\n* `[[menu: ]]` converts a comma-seprated list into a pretty-printed menu\n* Markdown wrapped in `` is processed.\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Garen Torikian. (MIT License)\n\nSee LICENSE for more info.\n\nBased mostly on Christopher Jeffrey (https://github.com/chjj/)\n","_id":"namp@0.2.17","dist":{"shasum":"94143badb5e456b2065b28e6334c755afb3f5b65","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.17.tgz","integrity":"sha512-4VqR7zVF382SA/yM9iBq3q4NL8Zu+ZX4WV3cNt9HicZ3UYk2qXqWKzEjn+FXi9gGCNBGIkE2UCxoiw6Kdih2Vw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDTIbfBIK+lUybtXe027KGZca9WkxnQIbWiBE2cGdOs0AiEAq3GIy6KosZo94QrPX53SBYm6okcCveeUdoHyboQQM9s="}]},"directories":{}},"0.2.18":{"name":"namp","version":"0.2.18","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more. Based on marked.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","dependencies":{"highlight.js":">=7.0.0"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions.\n* `[[keys: ]]` converts keyboard characters into a pretty-printed format\n* `[[menu: ]]` converts a comma-seprated list into a pretty-printed menu\n* Markdown wrapped in `` is processed.\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Garen Torikian. (MIT License)\n\nSee LICENSE for more info.\n\nBased mostly on Christopher Jeffrey (https://github.com/chjj/)\n","_id":"namp@0.2.18","dist":{"shasum":"63119551369dadc69cc6042fdafdbc5ff7a3dd5e","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.18.tgz","integrity":"sha512-9hIzExhJ5WkpwD6qsaDc5fD5L/e37PYbu1ZjoSCvI2L/zdsgrgDvYOfcZZ26Z5gawyOF1bnroazURBCWtB562w==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDOgjh0AMfGrFFoRvwIp7YbZ5g7yKfc8M5opCAYgBt9rQIgG34sO14sRYb42PiuILq9SK0wIdL/n3r2o2dG2jD5z7c="}]},"directories":{}},"0.2.19":{"name":"namp","version":"0.2.19","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more. Based on marked.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","dependencies":{"highlight.js":">=7.0.0"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions.\n* `[[keys: ]]` converts keyboard characters into a pretty-printed format\n* `[[menu: ]]` converts a comma-seprated list into a pretty-printed menu\n* Markdown wrapped in `` is processed.\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Garen Torikian. (MIT License)\n\nSee LICENSE for more info.\n\nBased mostly on Christopher Jeffrey (https://github.com/chjj/)\n","_id":"namp@0.2.19","dist":{"shasum":"77d27040dba2799aeda22ae567f5b51dfb351fd1","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.19.tgz","integrity":"sha512-YJSxMfFMq97WTV1AJLR+g6o6jAkZU2Odugn0rKCxOMf/lE/lNC467aBTsMQUAy/mIfJgRPws517YZ09ClBTNAw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICgZCyVHLDVy1yMQVxL0iiFNEkRr+vdJB1RnzE1YqQFgAiEA3BFjGAcHikFk+VOJH1bZhSYk3w0u4gQmW9pkA7jDnCg="}]},"directories":{}},"0.2.20":{"name":"namp","version":"0.2.20","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more. Based on marked.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","dependencies":{"highlight.js":">=7.0.0"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions.\n* `[[keys: ]]` converts keyboard characters into a pretty-printed format\n* `[[menu: ]]` converts a comma-seprated list into a pretty-printed menu\n* Markdown wrapped in `` is processed.\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Garen Torikian. (MIT License)\n\nSee LICENSE for more info.\n\nBased mostly on Christopher Jeffrey (https://github.com/chjj/)\n","_id":"namp@0.2.20","dist":{"shasum":"2ce3eac1c22912a9e55fde51b188a5e2f54c0321","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.20.tgz","integrity":"sha512-xM4SnzK06zyxwl+eAgLsDkz41237a7FLEfSgQrVDv7gfM3Ji3P//3TPICgiRZ7BOhVds2bPuiNDfwt3bUzic7Q==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBxwgV6zrHGpr42+5ApIlKW/iasUPHBRsx+NwdluJNFQAiEA1FhM73jzmEFVscnbkQIQ0HmXx8yZ7QhPDgYbeXFAGh8="}]},"directories":{}},"0.2.21":{"name":"namp","version":"0.2.21","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more. Based on marked.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","dependencies":{"highlight.js":">=7.0.0"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions.\n* `[[keys: ]]` converts keyboard characters into a pretty-printed format\n* `[[menu: ]]` converts a comma-seprated list into a pretty-printed menu\n* Markdown wrapped in `` is processed.\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Garen Torikian. (MIT License)\n\nSee LICENSE for more info.\n\nBased mostly on Christopher Jeffrey (https://github.com/chjj/)\n","_id":"namp@0.2.21","dist":{"shasum":"b34b4677e01e17dd6a0833b085806754e6904129","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.21.tgz","integrity":"sha512-kli3Y9LgF3KeEQigvL56CcipuVrHXwrz/S9MLDnHEgxLWlCTO1vEXIAxJWzFDawvsMiYrmY2xAM/ak3KuJ+fhQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCltgLHL8+zXhY1600pThFJ8bmI+FaeroBuvD7YsrnnwgIhAI03ll69SPJcjO28DKp6nTN2lxTffeJ/ZHYEwNECsmK5"}]},"directories":{}},"0.2.22":{"name":"namp","version":"0.2.22","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more. Based on marked.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","dependencies":{"highlight.js":">=7.0.0"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions.\n* `[[keys: ]]` converts keyboard characters into a pretty-printed format\n* `[[menu: ]]` converts a comma-seprated list into a pretty-printed menu\n* Markdown wrapped in `` is processed.\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Garen Torikian. (MIT License)\n\nSee LICENSE for more info.\n\nBased mostly on Christopher Jeffrey (https://github.com/chjj/)\n","_id":"namp@0.2.22","dist":{"shasum":"edc8d8ac8f8170733240749ff5f36d07605ad757","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.22.tgz","integrity":"sha512-fSjWyWyZPnude3uvEDN43f7YCpj27zvcfVb4UD+avJL6ZDI+YI3Fe6CpL+KafBLXfhIBcqaVC0KRwxzp75HbTQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCHQUgZYiknt3pCypo8OBrV+3aglirNs7smH8xmviXzWwIgezrCqImMjFtlGpQ14baYvlh6tFOmmW/gobHnp41+Rf0="}]},"directories":{}},"0.2.23":{"name":"namp","version":"0.2.23","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more. Based on marked.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","dependencies":{"highlight.js":">=7.0.0"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions.\n* `[[keys: ]]` converts keyboard characters into a pretty-printed format\n* `[[menu: ]]` converts a comma-seprated list into a pretty-printed menu\n* Markdown wrapped in `` is processed.\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Garen Torikian. (MIT License)\n\nSee LICENSE for more info.\n\nBased mostly on Christopher Jeffrey (https://github.com/chjj/)\n","_id":"namp@0.2.23","dist":{"shasum":"b86543bb51a53bc5d824639f7dfebfaa26d91954","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.23.tgz","integrity":"sha512-m+Aay8jR6w9lSFmp1qotmRGQJ7LaT6vALuS2kpV0aVH1y7SEg2iWoBw0jV2xBXgWkgJhM4bzEYhpKcEVpeZXTg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDyTxPgzS5gCKTjp74LE3CEe0S6Dw/YiJG+MSqoEA0g5QIhAJ9Bhyph9NMiZ7ZC/D3JWrE6QpPoAFckzOuNBclow+/w"}]},"directories":{}},"0.2.24":{"name":"namp","version":"0.2.24","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more. Based on marked.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","dependencies":{"highlight.js":">=7.0.0"},"readme":"# Introduction\n\n** IN THE MIDDLE OF A TRANSITION, NOT ALL FEATURES ARE FUNCITONAL YET **\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n* [The PHP Markdown Extra syntax](http://michelf.com/projects/php-markdown/extra/) (**NOT YET SUPPORTED**)\n* Supports [Maruku metadata](http://maruku.rubyforge.org/maruku.html#meta) (**NOT YET SUPPORTED**)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions.\n* `[[keys: ]]` converts keyboard characters into a pretty-printed format\n* `[[menu: ]]` converts a comma-seprated list into a pretty-printed menu\n* Markdown wrapped in `` is processed.\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Garen Torikian. (MIT License)\n\nSee LICENSE for more info.\n\nBased mostly on Christopher Jeffrey (https://github.com/chjj/)\n","readmeFilename":"README.md","_id":"namp@0.2.24","dist":{"shasum":"a3d08043693989603ee294883e6ea8aaed75ff65","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.24.tgz","integrity":"sha512-po4gR0M9fbZVjU9YwziRzmCjGXnc14GGH7EyQrtmQzgbgIOY6NGCPUH+Ka1esBnI7cORqYDHKhy5WnSj8WQwpg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDSJEsdK0FMzhLC55rum+tL1zwJ132wHh9wyW7l9xIKLwIgRfQzKlimsR69cKxt37dcIvb1+tB9QHPNcy9JludLvB4="}]},"_npmVersion":"1.1.65","_npmUser":{"name":"gjtorikian","email":"gjtorikian@gmail.com"},"directories":{}},"0.2.25":{"name":"namp","version":"0.2.25","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more. Based on marked.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"GPL","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","dependencies":{"highlight.js":">=7.0.0"},"readme":"# Introduction\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions.\n* `[[keys: ]]` converts keyboard characters into a pretty-printed format\n* `[[menu: ]]` converts a comma-seprated list into a pretty-printed menu\n* Markdown wrapped in `` is processed.\n* Width and height attributes can be added to images with ``\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Garen Torikian. (MIT License)\n\nSee LICENSE for more info.\n\nBased mostly on Christopher Jeffrey (https://github.com/chjj/)\n","readmeFilename":"README.md","_id":"namp@0.2.25","dist":{"shasum":"5913f0ea6dace62a47ca778a2efca5c28c85829c","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.25.tgz","integrity":"sha512-1FQ07u6aXr/lcbPj+AOcMWebsLJ0OBMYyJBzOBg7OJgxfseiuuI974j0G6hFWC0+D5tj/aVLY5v6unM5Ylmx0g==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDLwV/F8JKub4UiIvRt3sy3FOjhwjJ+fBpmgvHgmyGA0AIgVfhaZJ3XQUn2xfr72QU4ANxOeEFGLgm5f63r9NghPBE="}]},"_npmVersion":"1.1.65","_npmUser":{"name":"gjtorikian","email":"gjtorikian@gmail.com"},"directories":{}},"0.2.26":{"name":"namp","version":"0.2.26","description":"Markdown parser for Node, with Maruku, GFM, and PHP Extras support, plus more. Based on marked.","keywords":["markdown","maruku","gfm","text processing","ast"],"maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"licenses":[{"type":"MIT","url":"http://github.com/gjtorikian/namp/raw/master/LICENSE"}],"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"main":"./lib/namp.js","dependencies":{"highlight.js":">=7.0.0"},"gitHead":"39246cea93bf3b08814a98ec8bd3a70e404083a0","homepage":"https://github.com/gjtorikian/namp#readme","_id":"namp@0.2.26","_nodeVersion":"10.11.0","_npmVersion":"6.9.0","dist":{"integrity":"sha512-3mzUgP9mrlfzWxtZuIvtpQO88QmQ/b3JLPGJ0RP8R/igdjdb+c+SLqnOHmQRZJYDKB7jhaWJ7OGJbQEGXXPCFQ==","shasum":"5b9c1c7c1c042e8f52359f36994f10aec7e9e45b","tarball":"https://registry.npmjs.org/namp/-/namp-0.2.26.tgz","fileCount":188,"unpackedSize":255723,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdLdlZCRA9TVsSAnZWagAAxCkP/jnw4eW2QmSRxWUuT/+E\nVB+rh1U7u6hDP12pLIh+SbJYnFrkqiVL2kRlUR/fg53cUT986Z/6PUZp6NX5\ncJItD+118e9+1qa50dmUjR0Va1HD/osl3Ef6QxEd7blxv3SyPVDuIZ5X+5/z\nOPxVmqiO3kUhgBwC+yq4X91oWNuu1YuOmgRgKQktCfgyc/tUIdMMor5CXs/b\nmwm+HnEAOoEQ2v3HzJzZot4ReFTOpLWdi5kb294kF+uIZ7V5k50imOug/jKG\nhVofZuwd/St7FvzXQR6Dp2Eb4A+0Gt9zDeR6kmm9h293R6eg+dsFRSdk7cJf\nNFoefM1EeJYSf2QCUzjXysdzLmH9cvnPoCToIj2qN6QpU1zDZVvAKvgeAJUI\nG9ELcGM3d+pUN1vIah1qKAzyiT4601P9VRoVo4qoh0/ezOz3l1BT5yU5CZdl\nNwNMHq+ZwhyDjGP6ztNyi3Uf54DPJ8ifSiF79yzvAiZUAIdq6M5fUFCOAIdW\nqkqAAHOdUDS3lhSg7E9MLBkL4s85cAjfmLXuahffEixHaxSvPEWk6dHiXwge\nDs1Bx9kHH654odchueY+y8vLMOGpO1SWQPgqBKnrccGMELuaIT3qqX0+5dF/\nk2IEA/23stmbGct+1jx64PWVi4pgeEjfp0ojI4b+g5IZ/vQrUe5EyuezdF2U\nVqb6\r\n=Olki\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDoCBTWzN3z/v58KYrm8j8QWmrTDlNjnQ/buTXwh1Ve9QIhAKG1wmYyWgk8G9cTLEcm8nKBIEb2EdPIeIyMAYFdJeF1"}]},"_npmUser":{"name":"gjtorikian","email":"gjtorikian@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/namp_0.2.26_1563285848975_0.6276901579977947"},"_hasShrinkwrap":false}},"readme":"# Introduction\n\nThis is **no**t **a**nother **m**arkdown **p**arser.\n\nWell, okay, yes it is. But it handles a lot more than you're probably used to finding in just a single package. This generator can process Markdown files written in:\n\n* [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)\n* [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)\n\nIt also does some \"non-traditional\" work, too, that I find pretty damn useful:\n\n* _Inline_ metadata support (something Maruku does not do). By this I mean you can add an ID to anything; for example, this format: \n `Here is [a very special]{: #special .words1 .class1 lie=false} piece of text!` \nProduces this text: \n`Here is a very special piece of text` \nMaruku only allowed you to do inline IDs for stylized text, like `code`, **strong**, or _emphasis_. Now, if you wrap your text in `[ ]` brackets, you can continue to add Maruku metadata syntax and expect it to work.(**NOT YET SUPPORTED**)\n \n* Strikethroughs, using `~~`. For example, `This is a ~~strikethrough~~` turns into `This is a strikethrough`\n* Tables, with support for `left`,`right`, and `center` alignment (**NOT YET SUPPORTED**)\n* Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts). Awesome!\n* Build-time highlighting of `
` code blocks. Enabled by default, see below for configuration instructions.\n* `[[keys: ]]` converts keyboard characters into a pretty-printed format\n* `[[menu: ]]` converts a comma-seprated list into a pretty-printed menu\n* Markdown wrapped in `` is processed.\n* Width and height attributes can be added to images with ``\n\nnamp was forked from [marked](https://github.com/chjj/marked), which is a super-fast Markdown parser that handles all the standard GFM syntax.\n\nFor a demonstration of all the additional add-ons, take a look at the _/doc_ folder.\n\n## Usage and Configuration\n\nFirst, install from npm:\n\n npm install namp\n\nThen, add the module via a `require()` statement, feed it a file, and let it go:\n\n```javascript\nvar namp = require('namp');\nvar fs = require('fs');\n\nfs.readFile(\"SYNTAX.md\", \"utf8\", function (err, data) {\n if (!err) {\n var output = namp(data, {highlight: true } );\n fs.writeFileSync(\"SYNTAX.html\", output.html);\n\n console.log(\"Finished! By the way, I found this metadata:\\n\" + console.log(output.metadata));\n }\n});\n```\n\nThat's it! Notice that the converter takes two parameters:\n\n* `data`, the contents of the Markdown file\n* `options`, an object containing the following properties: \n - `highlight` enables build-time syntax highlighting for code blocks (this is `true` by default). This uses [the highlight.js processor](http://softwaremaniacs.org/soft/highlight/en/), so you'll still need to define your own CSS for colors\n\nThe result of the conversion is an object with two properties:\n\n* `html`, the transformed HTML\n* `metadata`, an object containing the document metadata values (`undefined` if there's none)\n\n#### Document Metadata Handling\n\nA special note must be made for the way document metadata blocks are handled. These are a list of arbitrary `Key: Value` mappings defined at the very start of a document. They are optional, but can be useful as content to be used in other locations. _doc/SYNTAX.md_ shows how you can define these properties.\n\nHere's the original marked README:\n\n# marked\n\nA full-featured markdown parser and compiler, written in javascript.\nBuilt for speed.\n\n## Benchmarks\n\nnode v0.4.x\n\n``` bash\n$ node test --bench\nmarked completed in 12071ms.\nshowdown (reuse converter) completed in 27387ms.\nshowdown (new converter) completed in 75617ms.\nmarkdown-js completed in 70069ms.\n```\n\nnode v0.6.x\n\n``` bash\n$ node test --bench\nmarked completed in 6448ms.\nmarked (gfm) completed in 7357ms.\nmarked (pedantic) completed in 6092ms.\ndiscount completed in 7314ms.\nshowdown (reuse converter) completed in 16018ms.\nshowdown (new converter) completed in 18234ms.\nmarkdown-js completed in 24270ms.\n```\n\n__Marked is now faster than Discount, which is written in C.__\n\nFor those feeling skeptical: These benchmarks run the entire markdown test suite\n1000 times. The test suite tests every feature. It doesn't cater to specific\naspects.\n\n## Install\n\n``` bash\n$ npm install marked\n```\n\n## Another Javascript Markdown Parser\n\nThe point of marked was to create a markdown compiler where it was possible to\nfrequently parse huge chunks of markdown without having to worry about\ncaching the compiled output somehow...or blocking for an unnecesarily long time.\n\nmarked is very concise and still implements all markdown features. It is also\nnow fully compatible with the client-side.\n\nmarked more or less passes the official markdown test suite in its\nentirety. This is important because a surprising number of markdown compilers\ncannot pass more than a few tests. It was very difficult to get marked as\ncompliant as it is. It could have cut corners in several areas for the sake\nof performance, but did not in order to be exactly what you expect in terms\nof a markdown rendering. In fact, this is why marked could be considered at a\ndisadvantage in the benchmarks above.\n\nAlong with implementing every markdown feature, marked also implements\n[GFM features](http://github.github.com/github-flavored-markdown/).\n\n## Options\n\nmarked has 4 different switches which change behavior.\n\n- __pedantic__: Conform to obscure parts of `markdown.pl` as much as possible.\n Don't fix any of the original markdown bugs or poor behavior.\n- __gfm__: Enable github flavored markdown (enabled by default).\n- __sanitize__: Sanitize the output. Ignore any HTML that has been input.\n- __highlight__: A callback to highlight code blocks.\n\nNone of the above are mutually exclusive/inclusive.\n\n## Usage\n\n``` js\n// Set default options\nmarked.setOptions({\n gfm: true,\n pedantic: false,\n sanitize: true,\n // callback for code highlighter\n highlight: function(code, lang) {\n if (lang === 'js') {\n return javascriptHighlighter(code);\n }\n return code;\n }\n});\nconsole.log(marked('i am using __markdown__.'));\n```\n\nYou also have direct access to the lexer and parser if you so desire.\n\n``` js\nvar tokens = marked.lexer(text);\nconsole.log(marked.parser(tokens));\n```\n\n``` bash\n$ node\n> require('marked').lexer('> i am using marked.')\n[ { type: 'blockquote_start' },\n { type: 'paragraph',\n text: 'i am using marked.' },\n { type: 'blockquote_end' },\n links: {} ]\n```\n\n## CLI\n\n``` bash\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\nhello world
\n```\n\n## License\n\nCopyright (c) 2011-2012, Garen Torikian. (MIT License)\n\nSee LICENSE for more info.\n\nBased mostly on Christopher Jeffrey (https://github.com/chjj/)\n","maintainers":[{"name":"gjtorikian","email":"gjtorikian@gmail.com"}],"time":{"modified":"2022-06-20T19:48:16.274Z","created":"2012-02-20T16:46:50.060Z","0.1.1":"2012-02-20T16:46:51.654Z","0.1.2":"2012-02-20T16:51:02.733Z","0.1.3":"2012-02-21T00:11:54.985Z","0.1.4":"2012-02-23T01:07:24.044Z","0.1.6":"2012-04-23T07:21:49.090Z","0.1.7":"2012-04-23T07:32:43.561Z","0.1.8":"2012-06-22T07:48:18.807Z","0.2.0":"2012-07-16T23:40:53.174Z","0.2.1":"2012-07-18T00:58:50.710Z","0.2.2":"2012-07-31T22:41:53.865Z","0.2.3":"2012-07-31T22:52:01.098Z","0.2.4":"2012-08-04T00:13:57.721Z","0.2.5":"2012-08-04T03:44:08.456Z","0.2.6":"2012-08-08T21:08:03.074Z","0.2.8":"2012-08-10T21:31:01.766Z","0.2.9":"2012-08-15T16:17:17.271Z","0.2.10":"2012-08-31T22:18:00.868Z","0.2.11":"2012-09-10T23:36:30.448Z","0.2.12":"2012-09-11T20:26:38.379Z","0.2.13":"2012-09-14T22:21:39.180Z","0.2.14":"2012-10-24T00:56:32.830Z","0.2.15":"2012-10-24T07:50:36.871Z","0.2.16":"2012-10-24T18:30:50.372Z","0.2.17":"2012-10-24T20:05:13.453Z","0.2.18":"2012-10-24T20:44:30.383Z","0.2.19":"2012-10-24T23:07:52.894Z","0.2.20":"2012-10-25T19:07:43.920Z","0.2.21":"2012-10-25T23:47:59.087Z","0.2.22":"2012-10-25T23:58:17.875Z","0.2.23":"2012-10-26T00:16:04.703Z","0.2.24":"2012-11-02T18:43:54.159Z","0.2.25":"2012-11-21T20:37:33.893Z","0.2.26":"2019-07-16T14:04:09.126Z"},"repository":{"type":"git","url":"git://github.com/gjtorikian/namp.git"},"users":{"6174":true,"fgribreau":true},"homepage":"https://github.com/gjtorikian/namp#readme","keywords":["markdown","maruku","gfm","text processing","ast"],"contributors":[{"name":"Christopher Jeffrey"}],"bugs":{"url":"http://github.com/gjtorikian/namp/issues"},"readmeFilename":"README.md"}