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

NgDocBuildCategorySchema

No documentation has been provided.

Properties

NameTypeDescription
category
boolean | undefined

If parameter was provided, generator will import first parent category automatically (alias is -c)

expandable
boolean | undefined

Provide true if the category is expandable (alias is -e, false by default)

expanded
boolean | undefined

Provide true if the category is expanded by default (alias is -x, false by default)

name
string | undefined

Name of the category variable (alias is -n, title in PascalCase by default)

order
number | undefined

Order of the category in sidebar (alias is -o, NgDoc sorting categories by name by default)

path
inherited from SchematicArgv
string | undefined
route
string | undefined

Custom route for the category (alias is -r, parent folder name by default)

title
string

Title of the category (can be provided as string after command)