NgDocConfiguration
NgDoc configuration interface, that configure NgDoc library
export interface NgDocConfiguration { … }Members
Properties14 | |
api?: | The configuration for the API pages. Only the Vite engine reads it. |
cache?: boolean | undefined | Determines whether to use the cache or not. (enabled by default) |
demoApplication?: boolean | | The demo pages: one page per demo that loads only Angular and that demo, which isolated demos show in an iframe and "Open in new tab" opens, and one page per target of each playground, which isolated playgrounds show in iframes. Only the Vite engine builds them. By default only the pages with an isolated demo or playground get them. |
demoProviders?: | Imports the module whose default export lists the providers of the demo pages, for example |
docsPath?: string | undefined | Paths to your documentation location (e.g. "src/app") |
guide?: | The configuration for the guides |
isolatedDemos?: boolean | undefined | Shows every demo of the |
isolatedPlaygrounds?: boolean | undefined | Renders the demos of every playground in iframes, as |
keywords?: | The configuration for the global keywords. |
outDir?: string | undefined | The path to the output directory, where the documentation will be generated. (e.g. 'src') Remember that if you change this path, you also need to change the following:
|
repoConfig?: | The repository configuration. If it is defined, Ngoc will use it to display the "Suggest edits" button, and "View source" button, on each page. |
routePrefix?: string | undefined | Route prefix uses to add some additional route segment before documentation pages, you can use it e.g. to wrap documentation with additional route like "docs". |
shiki?: { themes: { light: string; dark: string; }; langs?: ( | Shiki configuration |
tsConfig?: string | undefined | The path to the tsconfig file (NgDoc uses tsconfig of your application by default, but you can override it) |