Getting Started
Writing content
API Documentation
Customization
Recipes
API References Develop
@ng-doc/builder / Interface

NgDocRepoConfig

The repository configuration interface.

Properties

NameTypeDescription
mainBranch
string

The develop branch name (e.g. "master"/"main")

platform
NgDocPlatform | undefined

The platform name (e.g. "github"/"gitlab")

releaseBranch
string

The release branch name (e.g. "release"), uses to generate correct links for the "View source" button

url
string

The URL of the repository (e.g. "https://github.com/ng-doc/ng-doc ")