Tiny helpers for creating consistenly-formatted markdown snippets.
npm install 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 with npm:
``sh`
$ npm install --save markdown-utils
`js`
const mdu = require('markdown-utils');
Create a markdown-formatted blockquote.
Params
* str {String}
Example
`js`
utils.blockquote('This is a blockquote');
//=> '> This is a blockquote'
Create a markdown-formatted snippet.
Params
* str {String}
Example
`jsconst foo = bar;
utils.code('const foo = bar;');
//=> ''`
Create markdown-formatted deleted text: ~~text~~.
Params
* str {String}
Example
`js`
utils.del('text');
//=> '~~text~~'
Create a markdown-formatted em.
Params
* str {String}
Example
`js`
utils.em('This is emphasized');
//=> '_This is emphasized_'
Create a markdown-formatted heading.
Params
* str {String}level
* {Number}
Example
`js`
utils.h(1, 'This is a heading');
//=> '# This is a heading'
Create a markdown-formatted h1 heading.
Params
* str {String}
Example
`js`
utils.h1('This is a heading');
//=> '# This is a heading'
Create a markdown-formatted h2 heading.
Params
* str {String}
Example
`js`
utils.h2('This is a heading');
//=> '## This is a heading'
Create a markdown-formatted h3 heading.
Params
* str {String}
Example
`js`
utils.h3('This is a heading');
//=> '### This is a heading'
Create a markdown-formatted h4 heading.
Params
* str {String}
Example
`js`
utils.h4('This is a heading');
//=> '#### This is a heading'
Create a markdown-formatted h5 heading.
Params
* str {String}
Example
`js`
utils.h5('This is a heading');
//=> '##### This is a heading'
Create a markdown-formatted h6 heading.
Params
* str {String}
Example
`js`
utils.h6('This is a heading');
//=> '###### This is a heading'
Create a markdown-formatted heading.
Params
* str {String}level
* {Number}
Example
`js`
utils.heading('This is a heading', 1);
//=> '# This is a heading'
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
`js`
utils.hr();
//=> '*'
Create a markdown-formatted link from the given values.
Params
* anchor {String}href
* {String}title
* {String}
Example
`js`
utils.link('fs-utils', 'https://github.com/assemble/fs-utils', 'hover title');
//=> fs-utils
Create a markdown-formatted anchor link from the given values.
Params
* anchor {String}href
* {String}title
* {String}
Example
`js`
utils.anchor('embed', 'assemble/handlebars-helpers/lib/code.js', 25, 'v0.6.0');
//=> embed
Create a markdown-formatted reference link from the given values.
Params
* id {String}url
* {String}title
* {String}
Example
`js`
utils.reference('template', 'https://github/jonschlinkert/template', 'Make stuff!');
//=> [template]: https://github/jonschlinkert/template "Make stuff!"
Create a markdown-formatted image from the given values.
Params
* alt {String}src
* {String}title
* {String}
Example
`js
utils.image(alt, src);
//=> !Build Status
utils.image(alt, src, title);
//=> !Build Status
`
Create a markdown-formatted badge.
Params
* alt {String}img_url
* {String}url
* {String}
Example
`js`
utils.badge(alt, img_url, url);
//=> 
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
`js
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'
`
Create a markdown-formatted
snippet with or without lang.Results in:
Params
*
str {String}
* language {String}Examples
`js
utils.pre('const foo = bar;');
``html
const foo = bar;
`$3
Create a markdown-formatted code snippet with or without
lang.Results in:
Params
*
str {String}
* language {String}Examples
`js
utils.gfm('const foo = bar;', 'js');
``js
const foo = bar;
`$3
Create markdown-formatted bold text.
Params
*
str {String}Example
`js
utils.strong('This is bold');
//=> 'This is bold'
`$3
Create a markdown-formatted todo item.
Params
*
str {String}Example
`js
utils.todo('this is a todo.');
//=> '- [ ] this is a todo'utils.todo('this is a completed todo.', true);
//=> '- [x] this is a todo'
`About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Running Tests
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:
`sh
$ npm install && npm test
`
Building docs
_(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:
`sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
``You might also be interested in these projects:
* gfm-code-blocks: Extract gfm (GitHub Flavored Markdown) fenced code blocks from a string. | homepage fenced code blocks from a string.")
* markdown-link: Micro util for generating a single markdown link. | homepage
* markdown-toc: Generate a markdown TOC (table of contents) with Remarkable. | homepage with Remarkable.")
* remarkable: Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in… more | homepage
| Commits | Contributor |
| --- | --- |
| 49 | jonschlinkert |
| 12 | adjohnson916 |
Jon Schlinkert
* LinkedIn Profile
* GitHub Profile
* Twitter Profile
Copyright © 2018, Jon Schlinkert.
Released under the MIT License.
*
_This file was generated by verb-generate-readme, v0.6.0, on July 05, 2018._