# markdown-reference

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

Latest version **0.1.0** (published 2015-03-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install markdown-reference
pnpm add markdown-reference
yarn add markdown-reference
bun add markdown-reference
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2015-03-21 |
| First published | 2015-03-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | link, markdown, md, ref, reference, reflink, url |

## Links

- npm: https://www.npmjs.com/package/markdown-reference
- Repository: https://github.com/jonschlinkert/markdown-reference
- Issues: https://github.com/jonschlinkert/markdown-reference/issues
- npm.io page: https://npm.io/package/markdown-reference

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 0.1.0 (latest) — 2015-03-21

## README

# 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._

---
_Source: https://npm.io/package/markdown-reference · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._