docpad-baseplugin

BasePlugin class for DocPad

Install

NPM

• Install: npm install --save docpad-baseplugin
• Module: require('docpad-baseplugin')

Editions

This package is published with the following editions:

• docpad-baseplugin aliases docpad-baseplugin/index.js which uses Editions to automatically select the correct edition for the consumers environment
• docpad-baseplugin/source/index.js is esnext source code with require for modules
• docpad-baseplugin/edition-node-0.10/index.js is esnext compiled for node.js >=0.10 with require for modules

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.

History

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

Contribute

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

Backers

Maintainers

These amazing people are maintaining this project:

• Benjamin Lupton

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton — view contributions

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

License

Unless stated otherwise all works are:

• Copyright © 2018+ Benjamin Lupton

and licensed under:

• MIT License