README.md 1.8 KB
Newer Older
Lab机器人's avatar
readme  
Lab机器人 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
# markdown-link [![NPM version](https://badge.fury.io/js/markdown-link.svg)](http://badge.fury.io/js/markdown-link)

> Micro util for generating a single markdown link.

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

```bash
npm i markdown-link --save
```

## Usage

```js
var mdlink = require('markdown-link');
```

## Usage
### [.link](./index.js#L18)

Create a markdown-formatted link from the given values.

* `anchor` **{String}**    
* `href` **{String}**    
* `title` **{String}**    

```js
mdlink('micromatch', 'https://github.com/jonschlinkert/micromatch', 'hover title');
//=> [micromatch](https://github.com/jonschlinkert/micromatch "hover title")
```

## 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-link/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 20, 2015._