Skip to content

Commit

Permalink
Update API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
yuqu committed Feb 18, 2020
1 parent e723517 commit 89ddfee
Show file tree
Hide file tree
Showing 16 changed files with 94 additions and 68 deletions.
11 changes: 11 additions & 0 deletions docs/cli.componentconfigfile.bitbucket.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@zeplin/cli](./cli.md) &gt; [ComponentConfigFile](./cli.componentconfigfile.md) &gt; [bitbucket](./cli.componentconfigfile.bitbucket.md)

## ComponentConfigFile.bitbucket property

<b>Signature:</b>

```typescript
bitbucket?: GitConfig;
```
4 changes: 2 additions & 2 deletions docs/cli.componentconfigfile.github.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

## ComponentConfigFile.github property

[GithubConfig](./cli.githubconfig.md)
[GitConfig](./cli.gitconfig.md)

<b>Signature:</b>

```typescript
github?: GithubConfig;
github?: GitConfig;
```
11 changes: 11 additions & 0 deletions docs/cli.componentconfigfile.gitlab.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@zeplin/cli](./cli.md) &gt; [ComponentConfigFile](./cli.componentconfigfile.md) &gt; [gitlab](./cli.componentconfigfile.gitlab.md)

## ComponentConfigFile.gitlab property

<b>Signature:</b>

```typescript
gitlab?: GitConfig;
```
4 changes: 3 additions & 1 deletion docs/cli.componentconfigfile.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@ export interface ComponentConfigFile

| Property | Type | Description |
| --- | --- | --- |
| [bitbucket](./cli.componentconfigfile.bitbucket.md) | <code>GitConfig</code> | |
| [components](./cli.componentconfigfile.components.md) | <code>ComponentConfig[]</code> | Union of [ComponentConfigBase](./cli.componentconfigbase.md) and [ComponentConfigCustom](./cli.componentconfigcustom.md) |
| [github](./cli.componentconfigfile.github.md) | <code>GithubConfig</code> | [GithubConfig](./cli.githubconfig.md) |
| [github](./cli.componentconfigfile.github.md) | <code>GitConfig</code> | [GitConfig](./cli.gitconfig.md) |
| [gitlab](./cli.componentconfigfile.gitlab.md) | <code>GitConfig</code> | |
| [links](./cli.componentconfigfile.links.md) | <code>LinkConfig[]</code> | Base URLs for custom link composition |
| [plugins](./cli.componentconfigfile.plugins.md) | <code>Plugin[]</code> | [Plugin](./cli.plugin.md) names and their configurations |
| [projects](./cli.componentconfigfile.projects.md) | <code>string[]</code> | Zeplin project IDs which the components belong to |
Expand Down
13 changes: 13 additions & 0 deletions docs/cli.gitconfig.branch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@zeplin/cli](./cli.md) &gt; [GitConfig](./cli.gitconfig.md) &gt; [branch](./cli.gitconfig.branch.md)

## GitConfig.branch property

Branch name

<b>Signature:</b>

```typescript
branch?: string;
```
22 changes: 22 additions & 0 deletions docs/cli.gitconfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@zeplin/cli](./cli.md) &gt; [GitConfig](./cli.gitconfig.md)

## GitConfig interface


<b>Signature:</b>

```typescript
export interface GitConfig
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [branch](./cli.gitconfig.branch.md) | <code>string</code> | Branch name |
| [path](./cli.gitconfig.path.md) | <code>string</code> | Optional path to the project on monorepos. |
| [repository](./cli.gitconfig.repository.md) | <code>string</code> | Repository name |
| [url](./cli.gitconfig.url.md) | <code>string</code> | Custom hostname for self-hosted Git repository |

4 changes: 2 additions & 2 deletions docs/cli.githubconfig.path.md → docs/cli.gitconfig.path.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@zeplin/cli](./cli.md) &gt; [GithubConfig](./cli.githubconfig.md) &gt; [path](./cli.githubconfig.path.md)
[Home](./index.md) &gt; [@zeplin/cli](./cli.md) &gt; [GitConfig](./cli.gitconfig.md) &gt; [path](./cli.gitconfig.path.md)

## GithubConfig.path property
## GitConfig.path property

Optional path to the project on monorepos.

Expand Down
13 changes: 13 additions & 0 deletions docs/cli.gitconfig.repository.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@zeplin/cli](./cli.md) &gt; [GitConfig](./cli.gitconfig.md) &gt; [repository](./cli.gitconfig.repository.md)

## GitConfig.repository property

Repository name

<b>Signature:</b>

```typescript
repository: string;
```
13 changes: 13 additions & 0 deletions docs/cli.gitconfig.url.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@zeplin/cli](./cli.md) &gt; [GitConfig](./cli.gitconfig.md) &gt; [url](./cli.gitconfig.url.md)

## GitConfig.url property

Custom hostname for self-hosted Git repository

<b>Signature:</b>

```typescript
url?: string;
```
13 changes: 0 additions & 13 deletions docs/cli.githubconfig.branch.md

This file was deleted.

22 changes: 0 additions & 22 deletions docs/cli.githubconfig.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/cli.githubconfig.repository.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/cli.githubconfig.url.md

This file was deleted.

2 changes: 2 additions & 0 deletions docs/cli.linktype.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@ export const enum LinkType

| Member | Value | Description |
| --- | --- | --- |
| bitbucket | <code>&quot;bitbucket&quot;</code> | |
| custom | <code>&quot;custom&quot;</code> | |
| github | <code>&quot;github&quot;</code> | |
| gitlab | <code>&quot;gitlab&quot;</code> | |
| storybook | <code>&quot;storybook&quot;</code> | |
| styleguidist | <code>&quot;styleguidist&quot;</code> | |

2 changes: 1 addition & 1 deletion docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) | |
Expand Down
2 changes: 1 addition & 1 deletion docs/cli.plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<b>Signature:</b>

```typescript
export interface Plugin
export interface Plugin
```

## Properties
Expand Down

0 comments on commit 89ddfee

Please sign in to comment.