Some text bold text
\"\r\n\r\n//Write markdown \r\nhammerdown().parse(htmlToConvert,function(error, markdown){\r\n\tif(error) \r\n\t\tthrow error;\r\n\r\n\tconsole.log(markdown);\r\n});\r\n\r\n//Outputs\r\n//\t# A Markdown Header\r\n//\r\n//\tSome text **bold text**\r\n```\r\n\r\n## Simple Example with streams\r\n\r\n```javascript\r\nvar hammerdown = require(\"hammerdown\");\r\n\r\n//HTML\r\nvar htmlToConvert = = \"Some text bold text
\"\r\n\r\n//Write markdown\r\nhammerdown().parse(htmlToConvert).pipe(process.stdout);\r\n\r\n//Outputs\r\n//\t# A Markdown Header\r\n//\r\n//\tSome text **bold text**\r\n```\r\n\r\n# Installation\r\n\r\n## npm Install\r\n\r\n```\r\nnpm install hammerdown\r\n```\r\n\r\n## Browser Install\r\n\r\n```\r\nbower install hammerdown\r\n```\r\n\r\nNOTE: If using in the browser use the following:\r\n\r\n```javascript\r\n//HTML\r\nvar htmlToConvert = = \"Some text bold text
\"\r\n\r\nhammerdown().parse(htmlToConvert,function(error, markdown){\r\n\tif(error) \r\n\t\tthrow error;\r\n\r\n\tconsole.log(markdown);\r\n});\r\n```\r\n\r\n\r\n## Github Flavored Markdown Example\r\n\r\n```javascript\r\nvar hammerdown = require(\"hammerdown\");\r\n\r\n//Write markdown\r\nvar htmlString = \"\" +\r\n\t\t\t\t\t\"\"+\r\n\t\t\t\t\t\t\"var awesomeoFunction = function(){\"+\r\n\t\t\t\t\t\t\t\"return true;\"+\r\n\t\t\t\t\t\t\"}\"+\r\n\t\t\t\t\t\"\"+\r\n\t\t\t\t\"\";\r\nhammerdown({type:\"gfm\"}).parse(htmlString).pipe(process.stdout);\r\n\r\n//Outputs\r\n// ```javascript\r\n//\tfunction myFunction(params){return true;};\r\n//\t```\r\n```\r\n\r\n# Purpose \r\n\r\nExisting html to markdown writers didn't:\r\n* Support windows *easily* ([html.md](https://github.com/neocotic/html.md))\r\n* Lack of support for github flavored markdown ([to-markdown](https://github.com/domchristie/to-markdown))\r\n* Didn't support streams \r\n\r\n## Why convert html to markdown?\r\n\r\nTo have an easy way to programatically generate a stream of markdown text from html. This library includes converters for standard markdown and it also includes [Github-Flavored-Markdown](https://help.github.com/articles/github-flavored-markdown) definitions.\r\n\r\nMarkdown is a mechanism to create documents. [See](http://daringfireball.net/projects/markdown/) for more details. Hammerdown allows developers to leverage the simplicity of Markdown from html text.\r\n\r\n# Gulp Plugin!\r\n\r\nFor adding to your build process checkout [gulp-hammerdown](https://github.com/tjchaplin/gulp-hammerdown)\r\n\r\n# Options\r\n\r\nHammerdown currently accepts one option: `type`. If `type` is `\"gfm\"` then hammerdown will produce markdown using github flavored markdown(gfm).\r\n\r\n# Examples\r\n\r\nBelow is a select group of examples. More examples can be found by looking at the integration tests.\r\n\r\n# Github Flavored Markdown Examples\r\n\r\n## Simple Example using file stream\r\n\r\n```javascript\r\nvar fs = require('fs');\r\nvar hammerdown = require('hammerdown');\r\n\r\nvar htmlFileStream = fs.createReadStream(\"anyHtmlFile.html\");\r\n\r\n//Output markdown\r\nhtmlFileStream.pipe(hammerdown()).pipe(process.stdout);\r\n\r\n//Outputs\r\n// # Any header\t\r\n// \r\n// Any **Content**\r\n```\r\n\r\n```html\r\n\r\n\r\n\r\n\r\n\tAny Content
\r\n\r\n\r\n```\r\n\r\n## Tables\r\n\r\n```javascript\r\nvar fs = require('fs')\r\nvar hammerdown = require('hammerdown');\r\n\r\nvar htmlFileStream = fs.createReadStream(\"anyTable.html\");\r\n\r\n//Output markdown\r\nhtmlFileStream.pipe(hammerdown({type:\"gfm\"})).pipe(process.stdout);\r\n\r\n//Outputs\r\n// |Header1|Header1|\r\n// |---|---|\r\n// |row1-col1|row1-col2|\r\n// |row2-col1|row2-col2|\r\n```\r\n\r\n```html\r\n\r\n\r\n\r\n\t\r\n\t\t| \r\n\t\t\t\t\tHeader1\r\n\t\t\t\t | \r\n\t\t\t\t\r\n\t\t\t\t\tHeader1\r\n\t\t\t\t | \r\n\t\t\t
|---|---|
| \r\n\t\t\t\t\trow1-col1\r\n\t\t\t\t | \r\n\t\t\t\t\r\n\t\t\t\t\trow1-col2\r\n\t\t\t\t | \r\n\t\t\t
| \r\n\t\t\t\t\trow2-col1\r\n\t\t\t\t | \r\n\t\t\t\t\r\n\t\t\t\t\trow2-col2\r\n\t\t\t\t | \r\n\t\t\t
\r\n\t\t\r\n\t\t\tvar awesomeoFunction = function(){\r\n\t\t\t\treturn true;\r\n\t\t\t};\r\n\t\t\r\n\t\t\r\n\t\r\n\r\n```\r\n\r\n# Credits and other frameworks\r\n\r\n* Thanks to [karlcows Markdown Test Runner](https://github.com/karlcow/markdown-testsuite) I was able to provide a solid set of tests\r\n\r\n* [to_markdown](https://github.com/domchristie/to-markdown) another good html to markdown tool by [domchristie](https://github.com/domchristie)","maintainers":[{"name":"tjchaplin","email":"tim.chaplin@ticktockdevelopment.com"}],"time":{"modified":"2022-06-18T18:49:16.763Z","created":"2014-03-04T22:46:07.451Z","0.0.1":"2014-03-04T22:46:07.451Z","0.0.2":"2014-03-05T22:55:37.514Z","0.0.3":"2014-03-05T23:02:38.136Z","0.0.4":"2014-03-06T08:47:03.271Z","0.0.5":"2014-03-06T18:10:23.629Z","0.0.6":"2014-03-06T18:20:30.073Z","0.0.7":"2014-03-07T20:17:19.901Z","0.0.8":"2014-03-07T20:29:22.599Z","0.0.9":"2014-03-10T23:18:53.888Z","0.0.10":"2014-03-11T07:08:56.092Z","0.0.11":"2014-03-11T08:01:34.297Z","0.0.12":"2014-03-11T09:06:42.711Z","0.0.13":"2014-04-10T21:07:34.796Z","0.0.14":"2014-04-10T22:22:57.037Z","0.0.15":"2014-04-11T06:41:06.172Z","0.0.16":"2014-04-11T07:25:51.107Z","0.0.17":"2014-04-12T08:42:05.807Z","0.0.18":"2014-04-12T13:08:17.216Z","0.0.19":"2015-01-24T02:19:59.665Z","1.0.0":"2015-01-24T10:44:01.764Z","1.0.1":"2015-01-24T13:45:18.683Z","1.1.0":"2015-01-26T18:12:29.289Z","2.0.0":"2015-01-27T22:06:44.081Z","2.0.1":"2015-01-27T22:25:16.985Z"},"homepage":"https://github.com/tjchaplin/hammerdown","keywords":["html","markdown","md","tomarkdown","html-md","converter","hammerdown","stream","converter","hammer","writer","fluent"],"repository":{"type":"git","url":"git://github.com/tjchaplin/hammerdown.git"},"author":{"name":"tjchaplin","email":"tjchaplin@hotmail.com","url":"http://tjchaplin.github.io/"},"bugs":{"url":"https://github.com/tjchaplin/hammerdown/issues"},"license":"MIT","readmeFilename":"README.md","users":{}}