docpad-baseplugin
BasePlugin class for DocPad
Last updated 4 years ago by bevryme .
MIT · Repository · Bugs · Original npm · Tarball · package.json 
$ npm install docpad-baseplugin
SYNC missed versions from official npm registry.

docpad-baseplugin

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

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.

Install

npm

  • Install: npm install --save docpad-baseplugin
  • Import: import * as pkg from ('docpad-baseplugin')
  • Require: const pkg = require('docpad-baseplugin')

Editions

This package is published with the following editions:

  • docpad-baseplugin aliases docpad-baseplugin/source/index.js
  • docpad-baseplugin/source/index.js is ESNext source code for Node.js 10 || 12 || 13 || 14 with Require for modules

TypeScript

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
  }
}

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:

Sponsors

No sponsors yet! Will you be the first?

GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

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

License

Unless stated otherwise all works are:

and licensed under:

Current Tags

27 Versions

Maintainers (1)
bevryme
Downloads
Total 0
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (4)
Dev Dependencies (12)
Dependents (3)

© 2010 - cnpmjs.org x YWFE | Home | YWFE