read-markdown

1.0.2 • Public • Published

read-markdown

A promise-based module for reading and parsing markdown files.

Installation

With npm:

npm install --save read-markdown

Or with Yarn:

yarn add read-markdown

Usage

Just supply a glob or array of glob patterns to your markdown files.

var readMarkdown = require('read-markdown')
 
readMarkdown('./path/to/files/**/*.md')
    .then(function(data){
        console.log(data)
    })
    .catch(console.error)

Options

  • results: Return results as an object or array. Default object
  • html: Parse the contents as HTML. Default: true

Package Sidebar

Install

npm i read-markdown

Weekly Downloads

112

Version

1.0.2

License

MIT

Unpacked Size

250 kB

Total Files

11

Last publish

Collaborators

  • amadoa
  • dalewray
  • codevelopit
  • mastaaaron
  • escasports
  • tbaustin
  • ken85rose