Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update docs #3673

Merged
merged 18 commits into from
Jun 28, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions components/comment/doc/index.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,21 @@ import { NzCommentModule } from 'ng-zorro-antd/comment';

## API

### nz-comment

| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| [nzAuthor] | The element to display as the comment author | `string \| TemplateRef<void>` | - |
| [nzDatetime] | A datetime element containing the time to be displayed | `string \| TemplateRef<void>` | - |

### Comment sections
| Element | Description |
| ----- | ----------- |
| `<nz-avatar nz-comment-avatar>` | The element to display as the comment avatar |
| `<nz-comment-content>` | The main content of the comment |
| `<nz-comment-action>` | The element items rendered below the comment content |
### [nz-comment-avatar]

The element to display as the comment avatar.

### nz-comment-content

The main content of the comment.

### nz-comment-action

The element items rendered below the comment content.
19 changes: 13 additions & 6 deletions components/comment/doc/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,21 @@ import { NzCommentModule } from 'ng-zorro-antd/comment';

## API

### nz-comment

| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| [nzAuthor] | 显示评论的作者 | `string \| TemplateRef<void>` | - |
| [nzDatetime] | 展示时间描述 | `string \| TemplateRef<void>` | - |

### 评论组成部分
| 元素 | 说明 |
| ----- | ----------- |
| `<nz-avatar nz-comment-avatar>` | 要显示为评论头像的元素 |
| `<nz-comment-content>` | 评论的主要内容 |
| `<nz-comment-action>` | 在评论内容下面呈现的操作项 |
### [nz-comment-avatar]

要显示为评论头像的元素。

### nz-comment-content

评论的主要内容。

### nz-comment-action

在评论内容下面呈现的操作项。
3 changes: 1 addition & 2 deletions components/form/doc/index.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,7 @@ import { NzFormModule } from 'ng-zorro-antd/form';

## API

### nz-form

### [nz-form]

| Property | Description | Type | Default Value |
| -------- | ----------- | ---- | ------------- |
Expand Down
2 changes: 1 addition & 1 deletion components/form/doc/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ import { NzFormModule } from 'ng-zorro-antd/form';

## API

### nz-form
### [nz-form]

| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
Expand Down