Getting Started
Writing content
API Documentation
Customization
Recipes
API References Develop
@ng-doc/builder / Function

renderTemplate

Generic types:T

Renders a template with the given options via Nunjucks.

Presentation

function renderTemplate(
  template: string,
  options?: NgDocRendererOptions<T> | undefined,
): string;

Returns

string

Parameters

NameTypeDescription
template
string

The template path to render.

options
NgDocRendererOptions<T> | undefined

The options to render the template with.