Need help with markdown-to-json?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

scottstanfield
233 Stars 59 Forks 87 Commits 10 Opened issues

Description

🕹️ Convert YAML front-matter in Markdown files to JSON. v0.5.1 is published on NPM. Current version is v0.5.3

Services available

!
?

Need anything else?

Contributors list

markdown-to-json

Build Status

Tool for converting YAML Front Matter in Markdown files to JSON files.

m2j
is used to read a folder of Markdown files, pulling out the YAML Front Matter from each, and saving it all as a JSON blob.

This is especially useful if you have a folder full of Markdown files that you want scanned and processed into a single JSON file, which can then be consumed by Angular on the client, cached in a Node server, or saved in a NoSQL database.

In addition to moving the YAML to JSON, a few extra elements are created:

  • iso8601
    formatted timestamp from
    date
    using Moment.js
  • preview
    is the first 70 or so characters of the actual raw Markdown content, with ellipses at the end
  • basename
    is the filename without the path or extension
  • content
    is created only if the content flag is enabled; raw Markdown content will be unabridged

Example

% m2j --help

Usage: m2j [options]

Options:

-h, --help               output usage information
-V, --version            output the version number
-w --width <int>         max width of preview text [70]. Set to 0 for no preview.
-p --pretty              format JSON with newlines
-c --content             include the full content of the file unabridged
-o --outfile <filename>  filename to save json to [output.json]

% m2j.js lottery.md

lottery.md

---
title: The Lottery Ticket
author: Anton C.
date: "2013-03-15 15:00"
template: article.jade
tags:
  - Fiction
  - Russian


Ivan Dmitritch, a middle-class man who lived with his family on an income of twelve hundred a year and was very well satisfied with his lot, sat down on the sofa after supper and began reading the newspaper.

output

{
  "files": [
    {
      "title": "The Lottery Ticket",
      "author": "Anton C.",
      "date": "1893-04-01",
      "template": "article.jade",
      "tags": [
        "Fiction",
        "Russian"
      ],
      "preview": "Ivan Dmitritch, a middle-class man who lived with his family on an …",
      "iso8601Date": "1893-04-01T00:00:00-07:00",
      "basename": "lottery.md"
    }
  ]
}

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.