proxy-generics-render

proxy-generics-render

Proxy Generic Render Service with Markdown-It. Converts markdown document with YAML to object with HTML and Metadata.

Looking for Proxy Engine? Looking for Proxy Generics?

Install

$ npm install --save proxy-generics-render

Configure

// config/proxyGenerics.js
module.exports = {
  // make the key render, alternatively make the key render_service to be the default render service
  render_service: {
    adapter: require('proxy-generic-render'),
    options: {
       // Must always be set to true
       html: true
    },
    plugins: [
     // Example Plugin (markdown-it-meta is required and already installed)
     // {
     //   plugin: require('markdown-it-meta'),
     //   options: {}
     // }
    ]
  }
}

Use

Create a markdown document

document.md

---
title: Hello World!
keywords: render service
runs: 0
score: 0.0
demographics:
 - {name: 'unknown'}
---
# Hello world!

 const document = fs.readFileSync('document.md', 'utf8')
 
 RenderGenericService.render(document)
  .then(doc => {
    // do something with doc
  })
  .catch(err => {
    // do something with error
  })