❤
npm
Sign UpSign In

markdown-engine

0.0.2 • Public • Published

{{markdown}}

A lightweight markdown engine for Express.

Example

app.js

'use strict';
 
var express = require('express');
var markdownEngine = require('./util/markdown-engine');
 
var app = express();
 
app.engine('md', markdownEngine.configure());
 
app.set('views', path.join(__dirname, 'views'));
app.set('view engine', 'md');
 
...
 

views/layout.html

<!DOCTYPE html>
<html>
  <head>
    <title>{{title}}</title>
  </head>
  <body>
    {{body}}
  </body>
</html>

Templating

Templates are written using Markdown and provide basic templating features.

My middle name is {{name}}

res.render('template', { name: 'danger' });

My middle name is danger

Partials

Partials can be included by using the following syntax:

{{> partial}}
{{> path/to/partial}}

By default, partials are expected to be located in the views/partials/ directory.

Caching

Template caching is enabled only in production. NODE_ENV=production

API

configure: Function

The configure call accepts an Object as an argument. It is not required, but allows you to specify a basePath for the engine. By default partials and templates are expected to live in the views directory in the root of your project. If your this directory happens to be placed somewhere else, use basePath to define it.

app.engine('md', markdownEngine.configure({basePath: __dirname});

Readme

Keywords

none

Package Sidebar

Install

npm i markdown-engine

Repository

github.com/kyledetella/markdown-engine

Homepage

github.com/kyledetella/markdown-engine

Weekly Downloads

2

Version

0.0.2

License

MIT

Last publish

Collaborators

  • kyledetella
Try on RunKit
Report malware