functional-examplesFUNCTIONAL-EXAMPLES
API/@functional-examples/documentation/createDocumentationPlugin

createDocumentationPlugin

function
function createDocumentationPlugin(options: {
  enableExtractor?: boolean;
  format?: "markdown" | "mdoc";
  outputDir?: string;
  templates?: string;
}): Plugin<{
  docs?: {
    hunks?: Record<string, string>;
    outputName?: string;
    skip?: boolean;
    template?: string;
  };
}>;

Create the documentation plugin.

PARAMETERS

NAMETYPEDESCRIPTION
options{ enableExtractor?: boolean; format?: "markdown" | "mdoc"; outputDir?: string; templates?: string }ā€”

RETURNS

Plugin<{ docs?: { hunks?: Record<string, string>; outputName?: string; skip?: boolean; template?: string } }>

EXAMPLES

import { createDocumentationPlugin } from '@functional-examples/documentation';

const config = {
  plugins: [
    createDocumentationPlugin({
      outputDir: './docs',
      format: 'markdown',
    }),
  ],
};