Repository files navigation

Convert a directory of Markdown files to HTML.

Uses thecommonmark Markdown renderer and thegray-matter frontmatter parser.

Install withnpm:

npm install --save md-directory

or, if usingYarn:

yarn add md-directory

Given a directoryposts with a filehi.md:

---title:foo---#bar

varmd=require('md-directory')md.parseDirSync('./posts')

returns:

{"hi.md":{"data":{"title":"foo"},"content":"<h1>bar</h1>\n"}}

Since version 1.0,md-directory no longer supports theextensions option since it was dropped byread-directory.

Usetransform.js to convert calls tomd-directory methods into the contents they return. It is highly recommended that you use the synchronous methodsmd.parseDirSync andmd.parseSync with Browserify.

varpath=require('path')varmd=require('md-directory')varcontents=md.parseDirSync(path.join(__dirname,'posts'))

browserify index.js -t md-directory/transform -o bundle.js

varcontents={"hi":{"data":{"title":"foo"},"content":"<h1>bar</h1>\n"}};

Note: to use this transform, the path to the file directory can not be a variable. If you use the async methods, the callback must be an ES5 function (not an ES6 arrow function) and the results will be inlined withprocess.nextTick. Seebrfs for more details on this behavior.

Read the contents of a directory and convert to Markdown asynchronously

Parameters

• dirString – The directory to read
• optsObject
  • opts.mdFunction alternate function to parse markdown, default: commonmark
  • opts.frontmatterFunction alternate function to parse frontmatter, default: gray-matter
  • opts.encodingString – encoding of files, default:utf8
  • opts.filterString – glob pattern for filtering files, default:**\/*.md
  • opts.ignoreString – glob pattern for ignoring files
  • opts.ignoreArray – array of glob patterns for ignoring files
  • opts.dirnamesBoolean – include or exclude subdirectory names in keys of returned object, default:false
  • opts.transformFunction – A function you can use to transform the contents of files after they are converted
• cb

Examples

varmd=require('md-directory')md.parseDir('./posts',function(err,contents){console.log(contents)})

Read the contents of a directory and convert to Markdown synchronously

Parameters

• dirString – The directory to read
• optsObject
  • opts.mdFunction alternate function to parse markdown, default: commonmark
  • opts.frontmatterFunction alternate function to parse frontmatter, default: gray-matter
  • opts.encodingString – encoding of files, default:utf8
  • opts.filterString – glob pattern for filtering files, default:**\/*.md
  • opts.ignoreString – glob pattern for ignoring files
  • opts.ignoreArray – array of glob patterns for ignoring files
  • opts.dirnamesBoolean – include or exclude subdirectory names in keys of returned object, default:false
  • opts.transformFunction – A function you can use to transform the contents of files after they are converted

Examples

varmd=require('md-directory')varcontents=md.parseDirSync('./posts')

Read the contents of a file and convert to Markdown asynchronously

Parameters

• filenameString – The filename to read
• optsObject
  • opts.mdFunction alternate function to parse markdown, default: commonmark
  • opts.frontmatterFunction alternate function to parse frontmatter, default: gray-matter
  • opts.encodingString – encoding of files, default:utf8
  • opts.transformFunction – A function you can use to transform the contents of files after they are converted
• cb

Examples

varmd=require('md-directory')md.parse('./post.md',function(err,contents){console.log(contents)})

Read the contents of a file and convert to Markdown synchronously

Parameters

• filenameString – The filename to read
• optsObject
  • opts.mdFunction alternate function to parse markdown, default: commonmark
  • opts.frontmatterFunction alternate function to parse frontmatter, default: gray-matter
  • opts.encodingString – encoding of files, default:utf8
  • opts.transformFunction – A function you can use to transform the contents of files after they are converted

Examples

varmd=require('md-directory')varcontents=md.parseSync('./post.md')

• sethvincent/read-directory
• substack/brfs

MIT