https://github.com/jaredhanson/marked-engine

Express-compatible Markdown rendering powered by marked.
https://github.com/jaredhanson/marked-engine

Last synced: 8 months ago
JSON representation

Express-compatible Markdown rendering powered by marked.

• Host: GitHub
• URL: https://github.com/jaredhanson/marked-engine
• Owner: jaredhanson
• License: mit
• Created: 2012-11-07T01:51:15.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2018-06-02T01:05:52.000Z (over 7 years ago)
• Last Synced: 2025-04-11T23:38:03.249Z (9 months ago)
• Language: JavaScript
• Size: 15.6 KB
• Stars: 5
• Watchers: 2
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# marked-engine

[![Version](https://img.shields.io/npm/v/marked-engine.svg?label=version)](https://www.npmjs.com/package/marked-engine)

[![Build](https://img.shields.io/travis/jaredhanson/marked-engine.svg)](https://travis-ci.org/jaredhanson/marked-engine)

[![Quality](https://img.shields.io/codeclimate/github/jaredhanson/marked-engine.svg?label=quality)](https://codeclimate.com/github/jaredhanson/marked-engine)

[![Coverage](https://img.shields.io/coveralls/jaredhanson/marked-engine.svg)](https://coveralls.io/r/jaredhanson/marked-engine)

[![Dependencies](https://img.shields.io/david/jaredhanson/marked-engine.svg)](https://david-dm.org/jaredhanson/marked-engine)

[Markdown](http://daringfireball.net/projects/markdown/) rendering, powered by

[marked](https://github.com/chjj/marked).

marked-engine is an [Express](http://expressjs.com/)-compatible template engine

for rendering Markdown.

## Install

```bash

$ npm install marked-engine

```

## Usage

Register `marked-engine` as the template engine for files ending with a ".md"

extension.

```js

app.engine('md', require('marked-engine').renderFile);

```

Render a response using Markdown.

```js

res.render('hello.md');

```

## License

[The MIT License](http://opensource.org/licenses/MIT)

Copyright (c) 2012-2017 Jared Hanson <[http://jaredhanson.net/](http://jaredhanson.net/)>