Skip to content
@ng-doc/app / Function

provideNgDocApp

Provides the NgDoc application configuration.

Add it to the application's providers, or to the providers of the route that holds the documentation, together with the other NgDoc providers: then NgDoc starts only when the reader opens the documentation, and its code stays out of the application's initial bundle. It starts with environment initializers, which run where it is provided. The server render waits until the code highlighter of playgrounds has loaded.

DeclarationTypeScript
function provideNgDocApp(
  config?: NgDocApplicationConfig | undefined,
): (EnvironmentProviders | Provider)[];

Returns

Parameters

NameTypeDescription
config
NgDocApplicationConfig | undefined

The optional application configuration.

Symbol
Kind
Function
Scope
@ng-doc/app
Edit this page