markdown-reference/README.md

Micro-util for generating a markdown-formatted reference link.

# markdown-reference [![NPM version](https://badge.fury.io/js/markdown-reference.svg)](http://badge.fury.io/js/markdown-reference)  [![Build Status](https://travis-ci.org/jonschlinkert/markdown-reference.svg)](https://travis-ci.org/jonschlinkert/markdown-reference) 

> Micro-util for generating a markdown-formatted reference link.

## Install with [npm](npmjs.org)

```bash
npm i markdown-reference --save
```

## Usage

```js
var mdreference = require('markdown-reference');
```

**Params**

* `id` **{String}**    
* `url` **{String}**    
* `title` **{String}**    

```js
mdreference('template', 'https://github/jonschlinkert/template', 'Make stuff!');
//=> [template]: https://github/jonschlinkert/template "Make stuff!"
```

## Related projects
* [remarkable](https://github.com/jonschlinkert/remarkable): Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in one.
* [markdown-toc](https://github.com/jonschlinkert/markdown-toc): Generate a markdown TOC (table of contents) with Remarkable.
* [markdown-utils](https://github.com/jonschlinkert/markdown-utils): Micro-utils for creating markdown snippets.
* [to-gfm-code-block](https://github.com/jonschlinkert/to-gfm-code-block): Generate a github-flavored-markdown fenced code block snippet.

## Running tests
Install dev dependencies.

```bash
npm i -d && npm test
```

## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/markdown-reference/issues)

## Author

**Jon Schlinkert**
 
+ [github/jonschlinkert](https://github.com/jonschlinkert)
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert) 

## License
Copyright (c) 2015 Jon Schlinkert  
Released under the MIT license

***

_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on March 21, 2015._