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

renderTemplateString

Generic types:T

Renders a template string with the given options via Nunjucks.

Presentation

function renderTemplateString(
  template: string,
  options: NgDocRendererOptions<T>,
): string;

Returns

string

Parameters

NameTypeDescription
template
string

The template string to render.

options
NgDocRendererOptions<T>

The options to render the template with.