marked-metadata-with-options v0.0.1

marked-metadata

Markdown parser (using marked) with metadata header support.

Installing

npm install marked-metadata

Then, just require marked-metadata in your project:

var mkmeta = require('marked-metadata');

How to use

marked-metadata was built on top of the awesome marked.
But sometimes you need some meta information about the markdown file.
Normally a pattern like is used to define a header metadata:

<!--
layout: post
title: hello world
-->

Or something like this pattern:

---
layout: post
title: hello world
---

With marked-metadata you can parse any header metadata, using the defineTokens method:

var md = new MarkedMetaData('./test/test.md');
md.defineTokens('<!--', '-->');

You can get just the markdown metadata:

var md = new MarkedMetaData('./test/test.md');
md.defineTokens('<!--', '-->');
var meta = md.metadata();

And you can get just the markdown content (without the header)

var md = new MarkedMetaData('./test/test.md');
md.defineTokens('<!--', '-->');
var content = md.markdown();

You can crop a markdown file by a given identifier:

var md2 = new MarkedMetaData('./test/test.md');
md2.defineTokens('<!--', '-->');
md2.markdown({ crop : '{{more}}'});

You can also pass through options for Marked:

var md = new MarkedMetaData('./test/test.md');
md.setOptions({
    smartLists: true,
    smartypants: true
});

Contribute

Fork > Pull-request

Tests

npm test