# tent-markdown-js [](https://travis-ci.org/tent/tent-markdown-js)
[Tent](https://tent.io) Dialect for [markdown-js](https://github.com/evilstreak/markdown-js).
## Installation
npm install tent-markdown
## Usage
### Node
```js
var markdown = require( "tent-markdown" ).markdown;
console.log( markdown.toHTML( "Hello *World*! #firstwords", "Tent", { footnotes: [], hashtagURITemplate: 'http://example.com/search?hashtag={hashtag}' } ) );
```
```html
Hello World! #firstwords
```
### Browser
```html
```
The above example is adapted from [markdown-js](https://github.com/evilstreak/markdown-js).
Simply put,
```javascript
var source = "^[Example Mention](0), *Bold*, _Italic_, ~Strikethrough~, [Regular link](https://tent.io)...",
entity_uris = ["https://entity.example.org"];
window.markdown.toHTML( source, 'Tent', { footnotes: entity_uris } )
```
where `entity_uris` is an `Array` of entity uris with indices mapping to integer links in the markdown source.
### Preprocessers
The jsonml may be manipulated using preprocessors before it is translated into html.
```javascript
addAttributeToLinks = function ( jsonml ) {
// Skip over anything that isn't a link
if (jsonml[0] !== 'link') return jsonml;
jsonml[1]['data-my-attribute'] = 'Hello World';
return jsonml;
}
var markdown = require( "tent-markdown" ).markdown;
console.log( markdown.toHTML( "https://example.com", "Tent", { preprocessors: [addAttributeToLinks] } ) );
```
```html
https://example.com
```
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request