createDocumenter() Function

Build ApiModel and create a instance of MarkdownDocumenter

Type

typescript

export declare function createDocumenter(
  docConfig: DocConfig,
  options?: GenerateMarkdownOptions,
): MarkdownDocumenter;

export declare function createDocumenter(
  docConfig: DocConfig,
  options?: GenerateMarkdownOptions,
): MarkdownDocumenter;

Examples

ts

const config = DocConfig.loadConfig();
const documenter = createDocumenter(config, { outputFolder: 'docs/api' });
// generate files
documenter.generateFiles();

const config = DocConfig.loadConfig();
const documenter = createDocumenter(config, { outputFolder: 'docs/api' });
// generate files
documenter.generateFiles();

Parameters

docConfig DocConfig
options GenerateMarkdownOptions optional

Returns `MarkdownDocumenter`