diff --git a/docs/cli.componentconfigfile.bitbucket.md b/docs/cli.componentconfigfile.bitbucket.md new file mode 100644 index 0000000..0d1b277 --- /dev/null +++ b/docs/cli.componentconfigfile.bitbucket.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@zeplin/cli](./cli.md) > [ComponentConfigFile](./cli.componentconfigfile.md) > [bitbucket](./cli.componentconfigfile.bitbucket.md) + +## ComponentConfigFile.bitbucket property + +Signature: + +```typescript +bitbucket?: GitConfig; +``` diff --git a/docs/cli.componentconfigfile.github.md b/docs/cli.componentconfigfile.github.md index 9e86744..19810a9 100644 --- a/docs/cli.componentconfigfile.github.md +++ b/docs/cli.componentconfigfile.github.md @@ -4,10 +4,10 @@ ## ComponentConfigFile.github property -[GithubConfig](./cli.githubconfig.md) +[GitConfig](./cli.gitconfig.md) Signature: ```typescript -github?: GithubConfig; +github?: GitConfig; ``` diff --git a/docs/cli.componentconfigfile.gitlab.md b/docs/cli.componentconfigfile.gitlab.md new file mode 100644 index 0000000..36a0c9c --- /dev/null +++ b/docs/cli.componentconfigfile.gitlab.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@zeplin/cli](./cli.md) > [ComponentConfigFile](./cli.componentconfigfile.md) > [gitlab](./cli.componentconfigfile.gitlab.md) + +## ComponentConfigFile.gitlab property + +Signature: + +```typescript +gitlab?: GitConfig; +``` diff --git a/docs/cli.componentconfigfile.md b/docs/cli.componentconfigfile.md index 57890ca..b124521 100644 --- a/docs/cli.componentconfigfile.md +++ b/docs/cli.componentconfigfile.md @@ -16,8 +16,10 @@ export interface ComponentConfigFile | Property | Type | Description | | --- | --- | --- | +| [bitbucket](./cli.componentconfigfile.bitbucket.md) | GitConfig | | | [components](./cli.componentconfigfile.components.md) | ComponentConfig[] | Union of [ComponentConfigBase](./cli.componentconfigbase.md) and [ComponentConfigCustom](./cli.componentconfigcustom.md) | -| [github](./cli.componentconfigfile.github.md) | GithubConfig | [GithubConfig](./cli.githubconfig.md) | +| [github](./cli.componentconfigfile.github.md) | GitConfig | [GitConfig](./cli.gitconfig.md) | +| [gitlab](./cli.componentconfigfile.gitlab.md) | GitConfig | | | [links](./cli.componentconfigfile.links.md) | LinkConfig[] | Base URLs for custom link composition | | [plugins](./cli.componentconfigfile.plugins.md) | Plugin[] | [Plugin](./cli.plugin.md) names and their configurations | | [projects](./cli.componentconfigfile.projects.md) | string[] | Zeplin project IDs which the components belong to | diff --git a/docs/cli.gitconfig.branch.md b/docs/cli.gitconfig.branch.md new file mode 100644 index 0000000..3cf7ce0 --- /dev/null +++ b/docs/cli.gitconfig.branch.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@zeplin/cli](./cli.md) > [GitConfig](./cli.gitconfig.md) > [branch](./cli.gitconfig.branch.md) + +## GitConfig.branch property + +Branch name + +Signature: + +```typescript +branch?: string; +``` diff --git a/docs/cli.gitconfig.md b/docs/cli.gitconfig.md new file mode 100644 index 0000000..cad0bda --- /dev/null +++ b/docs/cli.gitconfig.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@zeplin/cli](./cli.md) > [GitConfig](./cli.gitconfig.md) + +## GitConfig interface + + +Signature: + +```typescript +export interface GitConfig +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [branch](./cli.gitconfig.branch.md) | string | Branch name | +| [path](./cli.gitconfig.path.md) | string | Optional path to the project on monorepos. | +| [repository](./cli.gitconfig.repository.md) | string | Repository name | +| [url](./cli.gitconfig.url.md) | string | Custom hostname for self-hosted Git repository | + diff --git a/docs/cli.githubconfig.path.md b/docs/cli.gitconfig.path.md similarity index 50% rename from docs/cli.githubconfig.path.md rename to docs/cli.gitconfig.path.md index fe5c32c..8e6e85b 100644 --- a/docs/cli.githubconfig.path.md +++ b/docs/cli.gitconfig.path.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@zeplin/cli](./cli.md) > [GithubConfig](./cli.githubconfig.md) > [path](./cli.githubconfig.path.md) +[Home](./index.md) > [@zeplin/cli](./cli.md) > [GitConfig](./cli.gitconfig.md) > [path](./cli.gitconfig.path.md) -## GithubConfig.path property +## GitConfig.path property Optional path to the project on monorepos. diff --git a/docs/cli.gitconfig.repository.md b/docs/cli.gitconfig.repository.md new file mode 100644 index 0000000..96423e3 --- /dev/null +++ b/docs/cli.gitconfig.repository.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@zeplin/cli](./cli.md) > [GitConfig](./cli.gitconfig.md) > [repository](./cli.gitconfig.repository.md) + +## GitConfig.repository property + +Repository name + +Signature: + +```typescript +repository: string; +``` diff --git a/docs/cli.gitconfig.url.md b/docs/cli.gitconfig.url.md new file mode 100644 index 0000000..d95282e --- /dev/null +++ b/docs/cli.gitconfig.url.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@zeplin/cli](./cli.md) > [GitConfig](./cli.gitconfig.md) > [url](./cli.gitconfig.url.md) + +## GitConfig.url property + +Custom hostname for self-hosted Git repository + +Signature: + +```typescript +url?: string; +``` diff --git a/docs/cli.githubconfig.branch.md b/docs/cli.githubconfig.branch.md deleted file mode 100644 index 894c26a..0000000 --- a/docs/cli.githubconfig.branch.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@zeplin/cli](./cli.md) > [GithubConfig](./cli.githubconfig.md) > [branch](./cli.githubconfig.branch.md) - -## GithubConfig.branch property - -The branch name which the Github links will open - -Signature: - -```typescript -branch?: string; -``` diff --git a/docs/cli.githubconfig.md b/docs/cli.githubconfig.md deleted file mode 100644 index b7294c3..0000000 --- a/docs/cli.githubconfig.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@zeplin/cli](./cli.md) > [GithubConfig](./cli.githubconfig.md) - -## GithubConfig interface - - -Signature: - -```typescript -export interface GithubConfig -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [branch](./cli.githubconfig.branch.md) | string | The branch name which the Github links will open | -| [path](./cli.githubconfig.path.md) | string | Optional path to the project on monorepos. | -| [repository](./cli.githubconfig.repository.md) | string | Repository name | -| [url](./cli.githubconfig.url.md) | string | Custom url for self-hosted Github Enterprise | - diff --git a/docs/cli.githubconfig.repository.md b/docs/cli.githubconfig.repository.md deleted file mode 100644 index 6ba4cb8..0000000 --- a/docs/cli.githubconfig.repository.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@zeplin/cli](./cli.md) > [GithubConfig](./cli.githubconfig.md) > [repository](./cli.githubconfig.repository.md) - -## GithubConfig.repository property - -Repository name - -Signature: - -```typescript -repository: string; -``` diff --git a/docs/cli.githubconfig.url.md b/docs/cli.githubconfig.url.md deleted file mode 100644 index b24d1fb..0000000 --- a/docs/cli.githubconfig.url.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@zeplin/cli](./cli.md) > [GithubConfig](./cli.githubconfig.md) > [url](./cli.githubconfig.url.md) - -## GithubConfig.url property - -Custom url for self-hosted Github Enterprise - -Signature: - -```typescript -url?: string; -``` diff --git a/docs/cli.linktype.md b/docs/cli.linktype.md index 7329ea8..8d6fbd2 100644 --- a/docs/cli.linktype.md +++ b/docs/cli.linktype.md @@ -16,8 +16,10 @@ export const enum LinkType | Member | Value | Description | | --- | --- | --- | +| bitbucket | "bitbucket" | | | custom | "custom" | | | github | "github" | | +| gitlab | "gitlab" | | | storybook | "storybook" | | | styleguidist | "styleguidist" | | diff --git a/docs/cli.md b/docs/cli.md index 3ac26df..3c286bb 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -21,7 +21,7 @@ | [ComponentData](./cli.componentdata.md) | Contains processed component data | | [ConnectPlugin](./cli.connectplugin.md) | Interface for Zeplin CLI Connected Components plugins | | [CustomUrlConfig](./cli.customurlconfig.md) | Use it as a value of [ComponentConfigCustom](./cli.componentconfigcustom.md) keys for custom link composition | -| [GithubConfig](./cli.githubconfig.md) | | +| [GitConfig](./cli.gitconfig.md) | | | [Link](./cli.link.md) | Custom created link for a component | | [LinkConfig](./cli.linkconfig.md) | Base URLs for custom link composition | | [Plugin](./cli.plugin.md) | | diff --git a/docs/cli.plugin.md b/docs/cli.plugin.md index 9ece179..ae4ed6f 100644 --- a/docs/cli.plugin.md +++ b/docs/cli.plugin.md @@ -8,7 +8,7 @@ Signature: ```typescript -export interface Plugin +export interface Plugin ``` ## Properties