Plop Documentation plugin (@koober/plop-doc)

PlopJS plugin for documentation

Installation

npm install --save-dev @koober/plop-doc

Usage

In the plopfile.js of your project

// @ts-check
const { PlopPlugin } = require('@koober/plop-plugin');
const { default: PlopDocument, defaultTemplates } = require('@koober/plop-doc');

module.exports = (
  /** @type {import('@koober/plop-plugin').PlopModule} */
  plop
) => {
  // apply
  PlopPlugin.apply(
    plop,
    // Combine all plugins
    PlopPlugin.compose(
      // ...other plugins
      PlopDocument(plop, {
        templates: defaultTemplates,
      })
      // ...other plugins
    )
  );
};

License

MIT © Julien Polo [email protected]