https://github.com/yan-foto/electron-jade

Simple electron protocol inceptor to compile Jade files on the fly :bird:
https://github.com/yan-foto/electron-jade

Last synced: 3 months ago
JSON representation

Simple electron protocol inceptor to compile Jade files on the fly :bird:

• Host: GitHub
• URL: https://github.com/yan-foto/electron-jade
• Owner: yan-foto
• Created: 2015-08-05T18:01:20.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-04-16T07:12:01.000Z (over 8 years ago)
• Last Synced: 2024-03-03T04:40:23.985Z (10 months ago)
• Language: JavaScript
• Homepage:
• Size: 15.6 KB
• Stars: 7
• Watchers: 3
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# --- NOTICE OF DEPRECATION --

This package has been deprecated in favour of [electron-pug](https://www.npmjs.com/package/electron-pug) and is not maintained further.

# electron jade

This module is a simple `file` protocol interceptor for [electron](https://github.com/atom/electron) which compiles all (local) URLs to files with `.jade` extension (e.g `/home/electron-jade/index.jade`) on the fly.





![license](https://img.shields.io/npm/l/electron-jade.svg)

# Installation

```

npm install electron-jade

```

# Usage

Just initialize this module with desired options for [Jade](https://www.npmjs.com/package/jade) package and your locals:

```js

'use strict';

var app = require('app');

var locals = {/* ...*/};

var j = require('electron-jade')({pretty: true}, locals);

var BrowserWindow = require('browser-window');

// Standard stuff

app.on('ready', function () {

  mainWindow = new BrowserWindow({ width: 800, height: 600 });

  mainWindow.loadUrl('file://' + __dirname + '/index.jade');

  // the rest...

});

```

# Even more!

If you want to have least effort when developing electron packages, take a look at [neutron](https://github.com/yan-foto/neutron)!