Skip to content
This repository was archived by the owner on Sep 10, 2024. It is now read-only.

Creating a Plugin

Henry Gressmann edited this page Mar 20, 2016 · 9 revisions

Creating a Plugin for your Pad is very easy if you are familiar with nodeJS.

To get started, create a project folder and run npm init. Now, create a new file, index.js. This file acts as the config file for your project. Example for your index.js:

const pkg = require('./package.json');

module.exports = {

  //Gets passed $ and the padplus.config.json. $ documentation: https://github.com/cheeriojs/cheerio
  //The exported Function MUST return a object that includes $ and config after they have been modified!
  func: require('./modifyHtml'),

  //Entry point for Browserify
  //Included transforms: browserify-css, hbsfy
  clientJs: __dirname + '/main.js',

  //You can just pass in the package.json as config if you want to, but these are the things padplus can use:
  config: {
    name: '',
    version: pkg.version,
  },
};
```

##General Infos

##Creating a Plugin

##Creating Themes

Clone this wiki locally