docpad-baseplugin
BasePlugin class for DocPad
Usage
Install the dependency like so:
npm install --save docpad-baseplugin
Create your plugins using CoffeeScript like so:
module.exports = 'docpad-baseplugin' name: 'myplugin' initialConfig: # ...
Create your plugins using JavaScript like so:
moduleexports = 'docpad-baseplugin' { return 'myplugin' } { return {} } // ...
You can use boundation to scaffold the above.
To setup tests, see docpad-plugintester.
Install
- 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
aliasesdocpad-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:
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?
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:
- Copyright © 2018+ Benjamin Lupton
and licensed under: