NgDoc

What is NgDoc? Installation SSR Configuration NEW OPTIONS Migrations
Pages and categories UPDATED Blockquotes NEW STYLES Images and embeds NEW Code blocks Mermaid diagrams NEW Nunjucks Demo and Demo Pane Playground Keywords
Auto generation Documenting declarations Rendering API NEW
Page Processors Page Skeleton Layout Search Themes UPDATED Icons
Performance Ignoring file lines
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 ")

MIT © 2023 Aleksandr Skoropad