NgDocBuildPageSchema · API

The interface describes the possible parameters for generating the page, the generator can be called by the command below 123

ng g @ng-doc/builder:page

Here is an example showing how you can call a generator with all parameters

ng g @ng-doc/builder:page MyPage -r custom-route -m -c -o 1

DeclarationTypeScript

export interface NgDocBuildPageSchema extends SchematicArgv { … }

Members

Properties 7
category?: `boolean \| undefined`	If parameter was provided, generator will import first parent category automatically (alias is `-c`)
keyword?: `string \| undefined`	Keyword for the entity (alias is `-k`)
name?: `string \| undefined`	Name of the page variable (alias is `-n`, title in PascalCase by default)
order?: `number \| undefined`	Order of the page in sidebar (alias is `-o`, NgDoc sorting pages by name by default)
path?: `string \| undefined` inherited from `SchematicArgv`	—
route?: `string \| undefined`	Custom route for the page (alias is `-r`, parent folder name by default)
title: `string`	Title of the page (can be provided as string after command)