From-mark NPM | npm.io

From Mark

💫 Extract markdown file and convert it to another file format

Todo

Separator
Document detail
Heading 1 - 6
Paragraph
Empty Space
Image
Bullet
so on.

Install

npm i from-mark

Markdown to HTML

Usage

const FromMark = require('./')
const Options = {
  // Define options here
}

FromMark.toHTML('./sample.md', Options).then(result => {
  console.log(result)
})

Result

<html>
<head>
  <title>Home page</title>
  <meta content="This is home page">
  <meta content="width=device-width, initial-scale=1.0">

  <style>
    /* custom style you can write here */
    body {
      background-color: #ededed
    }
  </style>
</head>

<body>
  <h1>This is a heading 1</h1>
  <p>You can write anything here, and from-mark will be convert it to paragraph</p>
  <h2>This is a heading 2</h2>
  <h3>A heading 3, and</h3>
  <h4>A heading 4</h4>
  <p>And then, this is a last paragraph</p>

  <script>
    // custom script you can write here
    console.log("script loaded");
  </script>
</body>
</html>

Options for toHTML function

Name	Description	Type	Default
head	Insert custom tag or something before head tag	String	''
body	Insert custom tag or something before body tag	String	''
layout	Layout to be base for render, set to compact if you want render just a content or you can set with your own html layout *	String	full

See test.js for more detail

Markdown to Array of Object

Usage

const FromMark = require('./')

FromMark.toJSON('./sample.md').then(result => {
  console.log(result)
})

Result

{
  document: [{
    tag: 'title',
    content: 'Home page'
  }, {
    tag: 'meta',
    name: 'description',
    content: 'This is home page'
  }, {
    tag: 'meta',
    name: 'viewport',
    content: 'width=device-width, initial-scale=1.0'
  }],
  content: [{
    tag: 'h1',
    content: 'This is a heading 1'
  }, {
    tag: 'p',
    content: 'You can write anything here, and from-mark will be convert it to paragraph'
  }, {
    tag: 'h2',
    content: 'This is a heading 2'
  }, {
    tag: 'h3',
    content: 'A heading 3, and'
  }, {
    tag: 'h4',
    content: 'A heading 4'
  }, {
    tag: 'p',
    content: 'And then, this is a last paragraph'
  }],
  head: '<style>\n    /* custom style you can write here */\n    body {\n      background-color: #EDEDED;\n    }\n  </style>',
  body: '<script>\n    // custom script you can write here\n    console.log(\'script loaded\')\n  </script>' }