nufo

0.1.0 • Public • Published

NuFO

NPM version npm

Use Markdown to render NFO files, allowing you to both read rendered markdown in the terminal and to generate NFO files.

(Pronounced "New Eff Oh")

Install

npm install -g nufo

Config

Configuration is stored in ~/.NuFO/config.json and by default images are cached in ~/.NuFO/

Usage

nufo <markdown file>

Programmatic Usage

    var NuFO = require('nufo');
    var document = new NuFO({
        //the target markdown file
        file : '<filepath>',
        //for caching images fetched by URL
        cacheDir : '<cache directory>'
    });
    document.transform('NFO', function(err, result){
        if(err) throw err;
        // do something with 'result'
    });

Todo

  • support HTML
  • support Windows

Enjoy!

  • Abbey Hawk Sparrow

Dependencies (9)

Dev Dependencies (0)

    Package Sidebar

    Install

    npm i nufo

    Weekly Downloads

    8

    Version

    0.1.0

    License

    MIT

    Unpacked Size

    23.7 kB

    Total Files

    7

    Last publish

    Collaborators

    • khrome