Configuration

Every option of the configuration file, ng-doc.config.ts. The file default-exports an NgDocConfiguration object. All options are optional.

import { NgDocConfiguration } from '@ng-doc/builder';

const config: NgDocConfiguration = {
  routePrefix: 'docs',
};

export default config;

Options

guide

The header template is a Nunjucks template, not Markdown. It can use these variables:

<h1>{{ NgDocPage.title }}</h1>

{{ Metadata.description }}

api

Only the new engine reads these options.

Demo pages

Only the new engine reads these options. Isolated demos show a demo's page in an iframe (Isolated demos).

Without them, only the pages with an isolated demo get demo pages. demoApplication takes an object with one option:

repoConfig

import { NgDocConfiguration } from '@ng-doc/builder';

const config: NgDocConfiguration = {
  repoConfig: {
    url: 'https://github.com/ng-doc/ng-doc',
    mainBranch: 'main',
    releaseBranch: 'release',
  },
};

export default config;

keywords

Each global keyword is an NgDocGlobalKeyword:

Where NgDoc finds the file

NgDoc searches for the configuration file upward, folder by folder. The two engines start and stop the search in different folders: the new engine stops at the workspace root, and the legacy builders stop at your home directory.

So a file in src/ng-doc.config.ts is found only by the legacy builders. Put the file in the project folder or at the workspace root, where both engines find it.

The Vite plugin's generator.configFile, the --config flag of the ng-doc command, or the ngDoc.config option of the legacy builders can point to a specific file instead. See Builders, plugin and CLI and Legacy builders. Without a configuration file, every option keeps its default.

Defaults per engine

Paths are relative to the workspace root. The ng-doc command line interface uses its own defaults for the documentation, generated and cache folders (Builders, plugin and CLI).