Interface IContinuousIntegrationForDocumentsOptions

Since

5.0.5

Version

2023-11-25

interface IContinuousIntegrationForDocumentsOptions {
    docsDir: string;
    gitCommit?: boolean;
    projectName: string;
    readmeFileName?: string;
    readmeFileTableLine?: string;
    targetDir: string;
    targetRepositoryDir?: string;
    updateReadmeFile?: boolean;
    versionFile: string;
}

Index

Properties

docsDir gitCommit? projectName readmeFileName? readmeFileTableLine? targetDir targetRepositoryDir? updateReadmeFile? versionFile

Properties

docsDir

docsDir: string

`Optional` gitCommit

gitCommit?: boolean

projectName

projectName: string

`Optional` readmeFileName

readmeFileName?: string

`Optional` readmeFileTableLine

readmeFileTableLine?: string

targetDir

targetDir: string

`Optional` targetRepositoryDir

targetRepositoryDir?: string

`Optional` updateReadmeFile

updateReadmeFile?: boolean

versionFile

versionFile: string

Generated using TypeDoc