markdown-badge

Micro util for generating a markdown badge.

Install with npm

npm i markdown-badge --save

Usage

var mdbadge = require('markdown-badge');

Usage

.badge

Create a markdown-formatted badge.

• alt {String}
• img_url {String}
• url {String}

mdbadge(alt, img_url, url);
//=> [![Build Status](https://travis-ci.org/jonschlinkert/template.svg)](https://travis-ci.org/jonschlinkert/template)

Related projects

• markdown-image: Micro util for generating a single markdown link.
• markdown-link: Micro util for generating a single markdown link.
• markdown-toc: Generate a markdown TOC (table of contents) with Remarkable.
• markdown-utils: Micro-utils for creating markdown snippets.
• remarkable: Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in one.
• to-gfm-code-block: Generate a github-flavored-markdown fenced code block snippet.

Running tests

Install dev dependencies.

npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

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

---

This file was generated by verb-cli on March 20, 2015.