Mdify NPM | npm.io

mdify

Markdown helpers with metadata support.

:cloud: Installation

# Using npm
npm install --save mdify

# Using yarn
yarn add mdify

:clipboard: Example

const mdify = require("mdify");

let md = mdify.stringify({
    author: "Johnny B."
  , date: new Date()
  , tags: ["hello", "world"]
}, `## Hello World!
Hey **there**!`);

console.log(md);
// ---
// author: Johnny B.
// date: 2016-06-06T07:12:17.533Z
// tags:
//   - hello
//   - world
// ---
// ## Hello World!
// Hey **there**!


console.log(mdify.parse(md));
// { markdown: '\n## Hello World!\nHey **there**!',
//   metadata:
//    { author: 'Johnny B.',
//      date: Mon Jun 06 2016 10:12:17 GMT+0300 (EEST),
//      tags: [ 'hello', 'world' ] },
//   rawMeta: '---\nauthor: Johnny B.\ndate: 2016-06-06T07:12:17.533Z\ntags:\n  - hello\n  - world',
//   html: '<h2 id="helloworld">Hello World!</h2>\n\n<p>Hey <strong>there</strong>!</p>' }

:question: Get Help

There are few ways to get help:

Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
For bug reports and feature requests, open issues. :bug:
For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

`stringify(metadata, content, [options])`

Stringify metadata and content.

Params

Object metadata: The metadata object.
String content: The markdown content.
Object [options]: An object containing the following fields:
start (String): The start delimiter of the metadata (default: ---).
end (String): The end delimiter of the metadata (default: ---).
yamlOptions (Object): Custom js-yaml options.

Return

String The markdown content prefixed by the stringified metadata.

`parse(input, [options])`

Parses the markdown input and the metadata.

Params

String input: The markdown code. If it contains metadata, it will be parsed.
Object [options]: An object containing the following fields:
start (String): The metadata prefix (default: ---).
end (RegExp): The metadata end.
html (Boolean): If true, the markdown code will be parsed into HTML (default: true).
converterOptions (Object): The converter options passed to showdown.

Return

ParseResult

`writeFile(path, metadata, content, [options], [cb])`

Writes the generated content into a file.

Params

String path: The file path.
Object metadata: The metadata object.
String content: The markdown content.
Object [options]: The stringify options.
Function [cb]: The callback function.

`parseFile(path, [options], [cb])`

Parses a markdown file.

Params

String path: The file path.
Object [options]: The parser options.
Function [cb]: The callback function.

Return

ParseResult Only if cb was omitted.

An object containing the following fields:

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

Starring and sharing the projects you like :rocket:
—I love books! I will remember you after years if you buy me one. :grin: :book:
—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6