Some text bold text
" //Write markdown hammerdown().parse(htmlToConvert,function(error, markdown){ if(error) throw error; console.log(markdown); }); //Outputs // # A Markdown Header // // Some text **bold text** ``` ## Simple Example with streams ```javascript var hammerdown = require("hammerdown"); //HTML var htmlToConvert = = "Some text bold text
" //Write markdown hammerdown().parse(htmlToConvert).pipe(process.stdout); //Outputs // # A Markdown Header // // Some text **bold text** ``` # Installation ## npm Install ``` npm install hammerdown ``` ## Browser Install ``` bower install hammerdown ``` NOTE: If using in the browser use the following: ```javascript //HTML var htmlToConvert = = "Some text bold text
" hammerdown().parse(htmlToConvert,function(error, markdown){ if(error) throw error; console.log(markdown); }); ``` ## Github Flavored Markdown Example ```javascript var hammerdown = require("hammerdown"); //Write markdown var htmlString = "" +
""+
"var awesomeoFunction = function(){"+
"return true;"+
"}"+
""+
"";
hammerdown({type:"gfm"}).parse(htmlString).pipe(process.stdout);
//Outputs
// ```javascript
// function myFunction(params){return true;};
// ```
```
# Purpose
Existing html to markdown writers didn't:
* Support windows *easily* ([html.md](https://github.com/neocotic/html.md))
* Lack of support for github flavored markdown ([to-markdown](https://github.com/domchristie/to-markdown))
* Didn't support streams
## Why convert html to markdown?
To 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.
Markdown 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.
# Gulp Plugin!
For adding to your build process checkout [gulp-hammerdown](https://github.com/tjchaplin/gulp-hammerdown)
# Options
Hammerdown currently accepts one option: `type`. If `type` is `"gfm"` then hammerdown will produce markdown using github flavored markdown(gfm).
# Examples
Below is a select group of examples. More examples can be found by looking at the integration tests.
# Github Flavored Markdown Examples
## Simple Example using file stream
```javascript
var fs = require('fs');
var hammerdown = require('hammerdown');
var htmlFileStream = fs.createReadStream("anyHtmlFile.html");
//Output markdown
htmlFileStream.pipe(hammerdown()).pipe(process.stdout);
//Outputs
// # Any header
//
// Any **Content**
```
```html
Any Content
``` ## Tables ```javascript var fs = require('fs') var hammerdown = require('hammerdown'); var htmlFileStream = fs.createReadStream("anyTable.html"); //Output markdown htmlFileStream.pipe(hammerdown({type:"gfm"})).pipe(process.stdout); //Outputs // |Header1|Header1| // |---|---| // |row1-col1|row1-col2| // |row2-col1|row2-col2| ``` ```html| Header1 | Header1 |
|---|---|
| row1-col1 | row1-col2 |
| row2-col1 | row2-col2 |
var awesomeoFunction = function(){
return true;
};
```
# Credits and other frameworks
* Thanks to [karlcows Markdown Test Runner](https://github.com/karlcow/markdown-testsuite) I was able to provide a solid set of tests
* [to_markdown](https://github.com/domchristie/to-markdown) another good html to markdown tool by [domchristie](https://github.com/domchristie)
---
_Source: https://npm.io/package/hammerdown · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._