@ng-doc/builder
Version:
<!-- PROJECT LOGO --> <br /> <div align="center"> <a href="https://github.com/ng-doc/ng-doc"> <img src="https://ng-doc.com/assets/images/ng-doc.svg?raw=true" alt="Logo" height="150px"> </a>
23 lines (22 loc) • 580 B
TypeScript
import { NgDocPlatform } from '../types';
/**
* The repository configuration interface.
*/
export interface NgDocRepoConfig {
/**
* The URL of the repository (e.g. "https://github.com/ng-doc/ng-doc")
*/
url: string;
/**
* The develop branch name (e.g. "master"/"main")
*/
mainBranch: string;
/**
* The release branch name (e.g. "release"), uses to generate correct links for the "View source" button
*/
releaseBranch: string;
/**
* The platform name (e.g. "github"/"gitlab")
*/
platform?: NgDocPlatform;
}