marky-markdown-lite v1.2.0

marky-markdown-lite

A version of marky-markdown that does less.

This little module converts markdown to HTML with markdown-it (a fast and CommonMark compliant parser), then parses that HTML into a queryable DOM object using cheerio.

This module is inspired by marky-markdown, and has a very similar API. It does less, but has a much smaller dependency footprint because it doesn't rely on any native C++ modules. If you need syntax highlighting, sanitized HTML, short emoji support, etc, use underlying markdown-it options, see Options below.

Installation

npm install marky-markdown-lite --save

Usage

const marky = require('marky-markdown-lite')

// Give marky a markdown string:
var $ = marky('## Some Heading')

// Then use jQuery-style cheerio selectors:
$('h2.title').text()
$('h2').addClass('welcome')
$.html()

// You can also use a markdown filename...
var $ = marky('some/markdown/file.md')

Tests

npm install
npm test

Options

You can use all the markdown-it options.

syntax

marky ( input [, options] )

• input (String) - Source string (could be also a path to a markdown file)
• options (Object) - markdown-it options

Accept HTML example

var opts = {
  html: true
}

var $ = marky('- Some list item <a href="item.html">here</a>', opts)

console.log( $('ul li a').attr('href') ) // Outputs: 'item.html'

Dependencies

• cheerio: Tiny, fast, and elegant implementation of core jQuery designed specifically for the server
• is-file: Tests if a given path resolves to a file.
• markdown-it: Markdown-it - modern pluggable markdown parser.

Dev Dependencies

• tap-spec: Formatted TAP output like Mocha's spec reporter
• tape: tap-producing test harness for node and browsers

License

MIT

Generated by package-json-to-readme