https://github.com/docpad/docpad-baseplugin

BasePlugin class for DocPad
https://github.com/docpad/docpad-baseplugin

docpad docpad-core

Last synced: about 1 month ago
JSON representation

BasePlugin class for DocPad

• Host: GitHub
• URL: https://github.com/docpad/docpad-baseplugin
• Owner: docpad
• License: other
• Created: 2018-08-20T09:35:15.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-01-01T06:19:17.000Z (over 1 year ago)
• Last Synced: 2025-04-01T17:56:33.449Z (about 2 months ago)
• Topics: docpad, docpad-core
• Language: JavaScript
• Homepage:
• Size: 376 KB
• Stars: 0
• Watchers: 3
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        


docpad-baseplugin

































BasePlugin class for DocPad

## Usage

[Complete API Documentation.](http://master.docpad-baseplugin.docpad.surge.sh/docs/index.html)

Install the dependency like so:

```bash

npm install --save docpad-baseplugin

```

Create your plugins using CoffeeScript like so:

```coffee

module.exports = class MyPlugin extends require('docpad-baseplugin') {

    name: 'myplugin'

    initialConfig: {}

    # ...

}

```

Create your plugins using JavaScript like so:

```javascript

module.exports = class MyPlugin extends require('docpad-baseplugin') {

    get name() {

        return 'myplugin'

    }

    get initialConfig() {

        return {}

    }

    // ...

}

```

You can use [boundation](https://github.com/bevry/boundation) to scaffold the above.

To setup tests, see [docpad-plugintester](https://github.com/docpad/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:

``` json

{

  "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:



Benjamin Lupton — view contributions



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