Skip to content
@ng-doc/keywords-loaders / Interface

NgDocKeywordsLoaderOptions

List of possible options for the NgDoc keywords loader.

DeclarationTypeScript
export interface NgDocKeywordsLoaderOptions { … }

Members

Properties

4
assetsPath?: string | undefined

The path to the assets folder of the NgDoc documentation. (default: /assets/ng-doc)

endpoint: string

The URL endpoint of the NgDoc documentation. (e.g. https://ng-doc.com )

guidesPrefix?: string | undefined

Defines the prefix to use for the external guides. (e.g. if the external guides have keyword Installation and you set guidesPrefix to External, the keyword will be ExternalInstallation)

loadGuides?: boolean | undefined

Whether to load the keywords for the external guides. (default: false)

Symbol
Kind
Interface
Scope
@ng-doc/keywords-loaders
Edit this page