ajithr / md-2-json

A simple library to convert markdown to json convertor

Front-end Web Developer | JavaScript | React.js | Blazor

Hey there 👋

This is Ajith Rajadurai. I'm passionate about the web technology and has been active in the web development since 2013.
Actively learning new technologies to gain more knowledge.

🔭 I’m currently interested in: React.js and Blazor
🌱 I’m currently learning: Node.js, Redux, Micro Front-end
😄 Pronouns: Aji, AJ
📫 How to reach me:

md-2-json's Issues

> Blockquote characters are trimmed from the text

Hi @ajithr ,

I've been using this module for a while now and it is really making my job easier! However, I came across with an issue when have tried to parse markdown templates with blockquotes. I just created a small app and pushed it in my repository here

There is a test markdown template:

# Lorem Ipsum
"Neque porro quisquam est qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit..."
"There is no one who loves pain itself, who seeks after it and wants to have it, simply because it is pain..."

## What is Lorem Ipsum?
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.

> some quote

## Where does it come from?
Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, "Lorem ipsum dolor sit amet..", comes from a line in section 1.10.32.

The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.

> another quote

## Why do we use it?
It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).

> and another quote

## Where can I get some?
There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.

> guess what? quote!

The application is pretty simple:

console.clear();
const fs = require("fs");
const md2json = require("md-2-json");

const template = fs.readFileSync("template.md", { encoding : "utf-8"});

console.log(md2json.parse(template));

The output of this application is this:

{
  'Lorem Ipsum': {
    raw: '"Neque porro quisquam est qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit..."\n' +
      '"There is no one who loves pain itself, who seeks after it and wants to have it, simply because it is pain..."\n' +
      '\n' +
      '\n',
    'What is Lorem Ipsum?': {
      raw: "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.\n" +
        '\n' +
        '\n' +
        'some quote\n' +
        '\n'
    },
    'Where does it come from?': {
      raw: 'Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, "Lorem ipsum dolor sit amet..", comes from a line in section 1.10.32.\n' +
        '\n' +
        '\n' +
        'The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.\n' +
        '\n' +
        '\n' +
        'another quote\n' +
        '\n'
    },
    'Why do we use it?': {
      raw: "It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).\n" +
        '\n' +
        '\n' +
        'and another quote\n' +
        '\n'
    },
    'Where can I get some?': {
      raw: "There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.\n" +
        '\n' +
        '\n' +
        'guess what? quote!\n' +
        '\n'
    }
  }
}

Please note, that in every paragraph, the lines with a leading relation sign (which indicates that the specific line is a blockquote) is getting trimmed for some reason.

Can you take a look?

Thanks!
enisz

Dashed added through conversion from markdown to JSON

When the markdown file is transformed to JSON:

const obj = md2json.parse(str);

there is an issue with bulleted lists.
I have multiple lists like the following in my file:

components:
  - config
  - backend
state: unstable

After conversion to JSON, a dash is added to any line in the block after the first dash:

"heading ...": {
            "raw": "components:\n- config\n- backend\n- state: unstable\n"
}

``` is being ignored

Hashtags in code snippets being interpreted as headings

I'm using this module for a small tool at work. In a file I tried to process, there was a code snippet with hashtags at the beginning of a line. These are interpreted by md-2-json as headings, regardless of being inside a code block.