@ng-doc/core/interfaces/section-index.d.ts

<!-- PROJECT LOGO --> <br /> <div align="center"> <a href="https://github.com/ng-doc/ng-doc"> <img src="https://ng-doc.com/assets/images/ng-doc.svg?raw=true" alt="Logo" height="150px"> </a>

import { NgDocPageType } from '../types';
/**
 * Interface for a page index that builder generates.
 */
export interface NgDocPageIndex {
    /**
     * Generated breadcrumbs.
     */
    breadcrumbs: string[];
    /**
     * Title of the page.
     */
    title: string;
    /**
     * Section where the content is located.
     */
    section: string;
    /**
     * Indexed content
     * Usually content maybe undefined only for the API pages that have no content/documentation.
     */
    content?: string;
    /**
     * The type of the page.
     */
    pageType: NgDocPageType;
    /**
     * The route that can be used to navigate to the page.
     */
    route: string;
    /**
     * The url anchor of the section
     */
    fragment?: string;
}