docpad-baseplugin v1.4.0

BasePlugin class for DocPad

Usage

Complete API Documentation.

Install the dependency like so:

npm install --save docpad-baseplugin

Create your plugins using CoffeeScript like so:

module.exports = class MyPlugin extends require('docpad-baseplugin') {
    name: 'myplugin'
    initialConfig: {}
    # ...
}

Create your plugins using JavaScript like so:

module.exports = class MyPlugin extends require('docpad-baseplugin') {
    get name() {
        return 'myplugin'
    }
    get initialConfig() {
        return {}
    }
    // ...
}

You can use boundation to scaffold the above.

To setup tests, see docpad-plugintester.

npm

This project provides its type information via inline JSDoc Comments. To make use of this in TypeScript, set your maxNodeModuleJsDepth compiler option to 5 or thereabouts. You can accomlish this via your tsconfig.json file like so:

{
  "compilerOptions": {
    "maxNodeModuleJsDepth": 5
  }
}

Discover the release history by heading on over to the HISTORY.md file.

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

These amazing people are maintaining this project:

No sponsors yet! Will you be the first?

These amazing people have contributed code to this project:

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Unless stated otherwise all works are:

and licensed under: