Code Monkey home page Code Monkey logo

marked-middleware's Introduction

markdown-middleware

middleware for serving markdown files as rendered HTML. It makes an effort to render a closely as possible to the style of github but stops short of actually using githubs API to keep performance snappy.

Installation

$ npm install markdown-middleware --save

then in your app:

var markdown = require('markdown-middleware')

Usage

just make sure you use it before static or similar middleware

app.use(markdown({
  // files will be looked for relative to
  // to this path
  directory: __dirname + '/public'
}))

For those contributing

before anything, just install the dependecies ...

$ npm install

Running the mocha tests

$ ./node_module/.bin/gulp test:mocha

Running the istanbul coverage

$ ./node_module/.bin/gulp test:istanbul

auto reloading watching

point your browser to localhost:3001/coverage for auto-reloaded coverage page :)

$ npm install
$ ./node_module/.bin/gulp watch

marked-middleware's People

Contributors

markuz-gj avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.