@ng-doc/core/interfaces/keyword-map.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>

export declare const KEYWORD_ALLOWED_LANGUAGES: readonly ["html"];
export type NgDocKeywordLanguage = (typeof KEYWORD_ALLOWED_LANGUAGES)[number];
export type NgDocKeywordType = 'link';
export interface NgDocKeyword {
    title: string;
    path: string;
    description?: string;
    type?: NgDocKeywordType;
    languages?: NgDocKeywordLanguage[];
}
/**
 * Global keyword configuration.
 */
export interface NgDocGlobalKeyword {
    /**
     * Keyword title that will be displayed in the link.
     * If not provided, the keyword will be displayed as is.
     */
    title?: string;
    /**
     * Url that will be used to generate the link.
     */
    url: string;
    /**
     * Description that will be displayed in a tooltip on hover.
     */
    description?: string;
    /**
     * Determines how the keyword should be displayed. (rendered as a link in inline code by default)
     */
    type?: NgDocKeywordType;
}