NgDoc

What is NgDoc? Installation SSR Configuration NEW OPTIONS Migrations
Pages and categories UPDATED Blockquotes NEW STYLES Images and embeds NEW Code blocks Mermaid diagrams NEW Nunjucks Demo and Demo Pane Playground Keywords
Auto generation Documenting declarations Rendering API NEW
Page Processors Page Skeleton Layout Search Themes UPDATED Icons
Performance Ignoring file lines
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

MIT © 2023 Aleksandr Skoropad