Home

Awesome

markdown-utils NPM version NPM monthly downloads NPM total downloads Linux Build Status

Tiny helpers for creating consistenly-formatted markdown snippets.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

$ npm install --save markdown-utils

Usage

const mdu = require('markdown-utils');

API

.blockquote

Create a markdown-formatted blockquote.

Params

Example

utils.blockquote('This is a blockquote');
//=> '> This is a blockquote'

.code

Create a markdown-formatted <code></code> snippet.

Params

Example

utils.code('const foo = bar;');
//=> '`const foo = bar;`'

.del

Create markdown-formatted deleted text: ~~text~~.

Params

Example

utils.del('text');
//=> '~~text~~'

.em

Create a markdown-formatted em.

Params

Example

utils.em('This is emphasized');
//=> '_This is emphasized_'

.h

Create a markdown-formatted heading.

Params

Example

utils.h(1, 'This is a heading');
//=> '# This is a heading'

.h1

Create a markdown-formatted h1 heading.

Params

Example

utils.h1('This is a heading');
//=> '# This is a heading'

.h2

Create a markdown-formatted h2 heading.

Params

Example

utils.h2('This is a heading');
//=> '## This is a heading'

.h3

Create a markdown-formatted h3 heading.

Params

Example

utils.h3('This is a heading');
//=> '### This is a heading'

.h4

Create a markdown-formatted h4 heading.

Params

Example

utils.h4('This is a heading');
//=> '#### This is a heading'

.h5

Create a markdown-formatted h5 heading.

Params

Example

utils.h5('This is a heading');
//=> '##### This is a heading'

.h6

Create a markdown-formatted h6 heading.

Params

Example

utils.h6('This is a heading');
//=> '###### This is a heading'

.heading

Create a markdown-formatted heading.

Params

Example

utils.heading('This is a heading', 1);
//=> '# This is a heading'

.hr

Create a markdown-formatted horizontal rule.

Params

Example

utils.hr();
//=> '***'

.link

Create a markdown-formatted link from the given values.

Params

Example

utils.link('fs-utils', 'https://github.com/assemble/fs-utils', 'hover title');
//=> [fs-utils](https://github.com/assemble/fs-utils "hover title")

.anchor

Create a markdown-formatted anchor link from the given values.

Params

Example

utils.anchor('embed', 'assemble/handlebars-helpers/lib/code.js', 25, 'v0.6.0');
//=> [embed](https://github.com/assemble/handlebars-helpers/blob/v0.6.0/lib/helpers/code.js#L25)

.reference

Create a markdown-formatted reference link from the given values.

Params

Example

utils.reference('template', 'https://github/jonschlinkert/template', 'Make stuff!');
//=> [template]: https://github/jonschlinkert/template "Make stuff!"

.image

Create a markdown-formatted image from the given values.

Params

Example

utils.image(alt, src);
//=> ![Build Status](https://travis-ci.org/jonschlinkert/template.svg)

utils.image(alt, src, title);
//=> ![Build Status](https://travis-ci.org/jonschlinkert/template.svg "This is title of image!")

.badge

Create a markdown-formatted badge.

Params

Example

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

.li

Returns a function to generate a plain-text/markdown list-item, allowing options to be cached for subsequent calls.

Params

Example

const li = listitem(options);

li(0, 'Level 0 list item');
//=> '- Level 0 list item'

li(1, 'Level 1 list item');
//=> '  * Level 1 list item'

li(2, 'Level 2 list item');
//=> '    + Level 2 list item'

.pre

Create a markdown-formatted <pre><code></code></pre> snippet with or without lang.

Results in:

Params

Examples

utils.pre('const foo = bar;');
<pre>
const foo = bar;
</pre>

.gfm

Create a markdown-formatted code snippet with or without lang.

Results in:

<pre> </pre>

Params

Examples

utils.gfm('const foo = bar;', 'js');
const foo = bar;

.strong

Create markdown-formatted bold text.

Params

Example

utils.strong('This is bold');
//=> '**This is bold**'

.todo

Create a markdown-formatted todo item.

Params

Example

utils.todo('this is a todo.');
//=> '- [ ] this is a todo'

utils.todo('this is a completed todo.', true);
//=> '- [x] this is a todo'

About

<details> <summary><strong>Contributing</strong></summary>

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

</details> <details> <summary><strong>Running Tests</strong></summary>

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test
</details> <details> <summary><strong>Building docs</strong></summary>

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb
</details>

Related projects

You might also be interested in these projects:

Contributors

CommitsContributor
49jonschlinkert
12adjohnson916

Author

Jon Schlinkert

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.6.0, on July 05, 2018.