![Deno 2.2 Improves Dependency Management and Expands Node.js Compatibility](https://cdn.sanity.io/images/cgdhsj6q/production/97774ea8c88cc8f4bed2766c31994ebc38116948-1664x1366.png?w=400&fit=max&auto=format)
Security News
Deno 2.2 Improves Dependency Management and Expands Node.js Compatibility
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
markdown-utils
Advanced tools
Micro-utils for creating markdown snippets.
Heads up! .list()
was removed in 0.6.0. If you still need this functionality use bulletsinstead.
npm i markdown-utils --save
(Table of contents generated by verb)
var mdu = require('markdown-utils');
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)
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)
Create a markdown-formatted blockquote.
Params
str
{String}Example
utils.blockquote('This is a blockquote');
//=> '> This is a blockquote'
Create a markdown-formatted <code></code>
snippet.
Params
str
{String}Example
utils.code('var foo = bar;');
//=> '`var foo = bar;`'
Create markdown-formatted <del></del>
.
Params
str
{String}Example
utils.del('text');
//=> '~~text~~'
Create a markdown-formatted em.
Params
str
{String}Example
utils.em('This is emphasized');
//=> '_This is emphasized_'
Create a markdown-formatted heading.
Params
str
{String}level
{Number}Example
utils.h(1, 'This is a heading');
//=> '# This is a heading'
Create a markdown-formatted h1 heading.
Params
str
{String}Example
utils.h1('This is a heading');
//=> '# This is a heading'
Create a markdown-formatted h2 heading.
Params
str
{String}Example
utils.h2('This is a heading');
//=> '## This is a heading'
Create a markdown-formatted h3 heading.
Params
str
{String}Example
utils.h3('This is a heading');
//=> '### This is a heading'
Create a markdown-formatted h4 heading.
Params
str
{String}Example
utils.h4('This is a heading');
//=> '#### This is a heading'
Create a markdown-formatted h5 heading.
Params
str
{String}Example
utils.h5('This is a heading');
//=> '##### This is a heading'
Create a markdown-formatted h6 heading.
Params
str
{String}Example
utils.h6('This is a heading');
//=> '###### This is a heading'
Create a markdown-formatted heading.
Params
str
{String}level
{Number}Example
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 used for front matter.Example
utils.hr();
//=> '***'
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!")
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")
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, [expand-range] will be used to generate an array of bullets (visit [expand-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 [expand-range] to modify the bullet for an item as it's generated. See the [examples].
Example
var 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 <pre><code></code></pre>
snippet with or without lang.
Results in:
Params
str
{String}language
{String}Examples
utils.pre('var foo = bar;');
var foo = bar;
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!"
Create markdown-formatted bold text.
Params
str
{String}Example
utils.strong('This is bold');
//=> '**This is bold**'
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'
Install dev dependencies:
npm i -d && npm test
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue
Jon Schlinkert
github/jonschlinkert twitter/jonschlinkert
Copyright (c) 2015 Jon Schlinkert Released under the MIT license.
This file was generated by verb-cli on April 29, 2015.
FAQs
Tiny helpers for creating consistenly-formatted markdown snippets.
The npm package markdown-utils receives a total of 1,567 weekly downloads. As such, markdown-utils popularity was classified as popular.
We found that markdown-utils demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.