markdown-utils

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

• str {String}

Example

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

.code

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

Params

• str {String}

Example

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

.del

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

Params

• str {String}

Example

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

.em

Create a markdown-formatted em.

Params

• str {String}

Example

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

.h

Create a markdown-formatted heading.

Params

• str {String}
• level {Number}

Example

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

.h1

Create a markdown-formatted h1 heading.

Params

• str {String}

Example

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

.h2

Create a markdown-formatted h2 heading.

Params

• str {String}

Example

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

.h3

Create a markdown-formatted h3 heading.

Params

• str {String}

Example

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

.h4

Create a markdown-formatted h4 heading.

Params

• str {String}

Example

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

.h5

Create a markdown-formatted h5 heading.

Params

• str {String}

Example

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

.h6

Create a markdown-formatted h6 heading.

Params

• str {String}

Example

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

.heading

Create a markdown-formatted heading.

Params

• str {String}
• level {Number}

Example

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

.hr

Create a markdown-formatted horizontal rule.

Params

• str {String}: Alternate string to use. Default is *** to avoid collision with --- which is commonly used for front-matter.

Example

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

.link

Create a markdown-formatted link from the given values.

Params

• anchor {String}
• href {String}
• title {String}

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

• anchor {String}
• href {String}
• title {String}

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

• id {String}
• url {String}
• title {String}

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

• alt {String}
• src {String}
• title {String}

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

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

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

• options {String}

• nobullet {Boolean}: Pass true if you only want the list iten and identation, but no bullets.
• indent {String}: The amount of leading indentation to use. default is ``.
• chars {String|Array}: If a string is passed, fill-range will be used to generate an array of bullets (visit fill-range to see all options.) Or directly pass an array of bullets, numbers, letters or other characters to use for each list item. Default ['-', '*', '+', '~']

• fn {Function}: pass a function fill-range to modify the bullet for an item as it's generated.

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

• str {String}
• language {String}

Examples

utils.pre('const foo = bar;');

<pre>
const foo = bar;
</pre>

.gfm

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

Results in:

Params

• str {String}
• language {String}

Examples

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

const foo = bar;

.strong

Create markdown-formatted bold text.

Params

• str {String}

Example

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

.todo

Create a markdown-formatted todo item.

Params

• str {String}

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

$ npm install && npm test

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

Related projects

You might also be interested in these projects:

• gfm-code-blocks: Extract gfm (GitHub Flavored Markdown) fenced code blocks from a string. | homepage
• markdown-link: Micro util for generating a single markdown link. | homepage
• markdown-toc: Generate a markdown TOC (table of contents) with Remarkable. | homepage
• remarkable: Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in… more | homepage

Contributors

Author

Jon Schlinkert

• LinkedIn Profile
• GitHub Profile
• Twitter Profile

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.

Current Tags

• 1.0.0                                ...           latest (6 years ago)

16 Versions

• 1.0.0                                ...           6 years ago
• 0.7.3                                ...           9 years ago
• 0.7.2                                ...           9 years ago
• 0.7.1                                ...           9 years ago
• 0.7.0                                ...           10 years ago
• 0.6.1                                ...           10 years ago
• 0.6.0                                ...           10 years ago
• 0.5.0                                ...           10 years ago
• 0.4.0                                ...           10 years ago
• 0.3.0                                ...           10 years ago
• 0.2.1                                ...           10 years ago
• 0.2.0                                ...           10 years ago
• 0.1.3                                ...           10 years ago
• 0.1.2                                ...           10 years ago
• 0.1.1                                ...           10 years ago
• 0.1.0                                ...           10 years ago