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

NgDocBaseEntity

Base interface for the NgDoc file entity

Properties

NameTypeDescription
hidden
boolean | undefined

If true the page will be hidden from the sidebar

order
number | undefined

Order is using for sorting entities in the sidebar

route
string | Route | undefined

The route of the entity (current sourceFileFolder name by default)

title
string

The entity title