Plugin

Interface defining the basic structure of a Docflow plugin. Includes plugin name and hook functions.

Signature

interface Plugin { name: string; hooks: {
    transformManifest?: (
      manifest: SidebarItem[],
      context: PluginContext,
    ) => SidebarItem[];
    provideGenerator?: () => MarkdownGenerator;
  } }

Parameters

• nameRequired · string
  

  Unique identifier for the plugin

• hooksRequired · object
  

  Object containing hook functions that the plugin can implement

  • transformManifest · function
    

    Hook to transform generated manifest data

  • provideGenerator · function
    

    Hook to provide a custom Markdown generator