MarkdownGenerator

Interface for Markdown generators that convert JSDoc data to Markdown documents.

Signature

interface MarkdownGenerator { generate(jsDocData: ParsedJSDoc, sourcePath?: string): MarkdownDocument; serialize(markdownDoc: MarkdownDocument): string; generateDocs(
    targetsWithJSDoc: TargetWithJSDoc,
    packagePath: string,
  ): GeneratedDoc }

Parameters

• generateRequired · function
  

  Function to convert JSDoc data to Markdown document structure

• serializeRequired · function
  

  Function to convert Markdown document to string

• generateDocsRequired · function
  

  Function to generate document files from targets