Nonviolent Pigeon Manifestation

    @fabrix/generics-render
    TypeScript icon, indicating that this package has built-in type declarations

    1.5.0 • Public • Published

    generics-render

    Gitter NPM version Build Status Test Coverage Dependency Status Follow @FabrixApp on Twitter

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

    Looking for Generics?

    Install

    $ npm install --save @fabrix/generics-render

    Configure

    // config/generics.js
    export const generics = {
      // make the key render, alternatively make the key render_service to be the default render service
      render_service: {
        adapter: require('@fabrix/generic-render').RenderGeneric,
        config: {
           // 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
      })

    Install

    npm i @fabrix/generics-render

    Homepage

    fabrix.app

    DownloadsWeekly Downloads

    22

    Version

    1.5.0

    License

    none

    Unpacked Size

    7.65 kB

    Total Files

    11

    Last publish

    Collaborators

    • scottbwyatt