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

NgDocPageIndex

Interface for a page index that builder generates.

Properties

NameTypeDescription
content
string | undefined

Indexed content Usually content maybe undefined only for the API pages that have no content/documentation.

fragment
string | undefined

The url anchor of the section

pageType
NgDocPageType

The type of the page.

route
string

The route that can be used to navigate to the page.

section
string

Section where the content is located.

title
string

Title of the page.