docs: update docs (NG-ZORRO#3673)

hsuanxyz · Jun 28, 2019 · 5a2bd45 · 5a2bd45
1 parent 132250c
commit 5a2bd45
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 15 deletions.
diff --git a/components/comment/doc/index.en-US.md b/components/comment/doc/index.en-US.md
@@ -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.
diff --git a/components/comment/doc/index.zh-CN.md b/components/comment/doc/index.zh-CN.md
@@ -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
+
+在评论内容下面呈现的操作项。
diff --git a/components/form/doc/index.en-US.md b/components/form/doc/index.en-US.md
@@ -52,8 +52,7 @@ import { NzFormModule } from 'ng-zorro-antd/form';
 
 ## API
 
-### nz-form
-
+### [nz-form]
 
 | Property | Description | Type | Default Value |
 | -------- | ----------- | ---- | ------------- |

diff --git a/components/form/doc/index.zh-CN.md b/components/form/doc/index.zh-CN.md
@@ -52,7 +52,7 @@ import { NzFormModule } from 'ng-zorro-antd/form';
 
 ## API
 
-### nz-form
+### [nz-form]
 
 | 参数 | 说明 | 类型 | 默认值 |
 | --- | --- | --- | --- |