NgDocConfiguration
NgDoc configuration interface, that configure NgDoc library
Properties
| Name | Type | Description |
|---|---|---|
| cache | boolean | undefined | Determines whether to use the cache or not. (enabled by default) |
| docsPath | string | undefined | Paths to your documentation location (e.g. "src/app") |
| guide | | The configuration for the guides |
| 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; }; } | undefined | Shiki configuration |
| tsConfig | string | undefined | The path to the tsconfig file (NgDoc uses tsconfig of your application by default, but you can override it) |