acyort-marked

Markdown parser for AcyOrt

Install

$ npm i acyort-marked -S

API

const Marked = require('acyort-marked')
const { headingIdFormater } = require('acyort-marked')

const config = {
  line_numbers: true,   // show code line numbers
  simple_mode: false,   // simple markdown parser, not highlights code, not heading id
  headingIdFormater: fn   // heading id format function
}

const marker = new Marked(config)

// default heading formater
headingIdFormater('Some text')

// parse option
const option = {
  line_numbers: true,
  simple_mode: false,
  headingIdFormater: fn
}

// parse markdown string
marker.parse('# H1', option)

Usage

const Marked = require('acyort-marked')
const { headingIdFormater } = require('acyort-marked')

console.log(headingIdFormater('aa bb'))
// aabb

let config = { line_numbers: true }
let marker = new Marked(config)

const heading = '# An h1 header'
const tasks = '- [x] it is done\n- [ ] it is not done'
const code = '\`\`\`html\n<h1>h1</h1>\n\`\`\`'

console.log(marker.parse(heading))
// <h1 id="anh1header">An h1 header</h1>

console.log(marker.parse(heading, { simple_mode: true }))
// <h1>An h1 header</h1>

console.log(marker.parse(heading, { headingIdFormater: text => 'heading' }))
// <h1 id="heading">An h1 header</h1>

console.log(marker.parse(tasks))
// <ul>
//  <li style="list-style:none">
//    <input type="checkbox" checked disabled /> it is done
//  </li>
//  <li style="list-style:none">
//    <input type="checkbox" disabled /> it is not done
//  </li>
// </ul>

console.log(marker.parse(code, { simple_mode: false }))
// <div class="hljs html">
//  <table>
//    <tbody>
//      <tr>
//        <td class="line">
//          <pre><span>1</span></pre>
//        </td>
//        <td class="code">
//          <pre>
//            <span class="hljs-tag">&lt;<span class="hljs-name">h1</span>&gt;</span>h1<span class="hljs-tag">&lt;/<span class="hljs-name">h1</span>&gt;</span>
//          </pre>
//        </td>
//      </tr>
//    </tbody>
//  </table>
// </div>

console.log(marker.parse(code, { simple_mode: true }))
// <pre><code>&lt;h1&gt;h1&lt;&#x2F;h1&gt;</code></pre>


config = { line_numbers: false, simple_mode: false }
marker = new Marked(config)
console.log(marker.parse(code))
// <div class="hljs html">
//  <pre>
//    <span class="hljs-tag">&lt;<span class="hljs-name">h1</span>&gt;</span>h1<span class="hljs-tag">&lt;/<span class="hljs-name">h1</span>&gt;</span>
//  </pre>
// </div>