From 45d21bd5d379a3bbc71b05131c60ed8b466fd399 Mon Sep 17 00:00:00 2001 From: Benjy Cui Date: Wed, 19 Oct 2016 15:21:09 +0800 Subject: [PATCH] =?UTF-8?q?Updated=20=E6=96=87=E6=A1=A3=E5=92=8C=E6=BC=94?= =?UTF-8?q?=E7=A4=BA=20Markdown=20=E6=96=87=E4=BB=B6=E7=9A=84=E5=90=84?= =?UTF-8?q?=E7=B1=BB=E5=8A=9F=E8=83=BD=E9=85=8D=E7=BD=AE=E8=AF=B4=E6=98=8E?= =?UTF-8?q?=20(markdown)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Configuration-for-Documentation-and-Demo.md | 34 +++++++++++++++++++ 文档和演示-Markdown-文件的各类功能配置说明.md | 33 ------------------ 2 files changed, 34 insertions(+), 33 deletions(-) create mode 100644 Configuration-for-Documentation-and-Demo.md delete mode 100644 文档和演示-Markdown-文件的各类功能配置说明.md diff --git a/Configuration-for-Documentation-and-Demo.md b/Configuration-for-Documentation-and-Demo.md new file mode 100644 index 0000000..027f5a9 --- /dev/null +++ b/Configuration-for-Documentation-and-Demo.md @@ -0,0 +1,34 @@ +We use [YAML](http://yaml.org/) to set the configuration of documentation. + +```yaml +--- +order: 1 +title: Introduction +--- +``` + +--- + +Configurations of documentation and demo are different. + +### Demo + +If a Markdown file is under a folder named `demo`, it is a demo. e.g.: https://github.com/ant-design/ant-design/blob/e1a6123aa6a4cf47b3be8d681692b7256d4485c6/components/checkbox/demo/controller.md + +- `order` 在当前页面下的展示顺序。 +- `title` 演示标题，可以使一个字符串，或者对象。当为对象时，对应的域为对应语言的标题。 + - zh-CN + - en-US +- `hidden` 隐藏此演示区块。 + +### Documentation + +If a Markdown file is not a demo, it is a documentation. e.g.: https://github.com/ant-design/ant-design/blob/e1a6123aa6a4cf47b3be8d681692b7256d4485c6/components/checkbox/index.md + +- `category` 文档分类，可自行定义。 +- `order` 在当前分类下的展示顺序。 +- `type` 组件类型，特别针对组件文档，目前有 `基本` `表单` `展示` `导航` `其他`。 +- `title` 文档标题，与演示标题一致支持多语言设置。 +- `subtitle` 文档副标题，与演示标题一致支持多语言设置。 +- `cols` 页面代码演示区块的展示列数，默认为 `2`，对于演示宽度不够的组件可设置为 `1`。 +- `disabled` 使侧边菜单的链接不可点。 \ No newline at end of file diff --git a/文档和演示-Markdown-文件的各类功能配置说明.md b/文档和演示-Markdown-文件的各类功能配置说明.md deleted file mode 100644 index 3808d7e..0000000 --- a/文档和演示-Markdown-文件的各类功能配置说明.md +++ /dev/null @@ -1,33 +0,0 @@ -配置指 Markdown 文件中标题以下和第一处 `---` 分割线以上的配置。例如： - -``` -# 标题 - -- order: 1 - ---- -``` - ---- - -主要分成两种，分别的配置如下： - -### 项目文档 - -例如：https://github.com/ant-design/ant-design/blob/e1a6123aa6a4cf47b3be8d681692b7256d4485c6/components/checkbox/index.md - -- `category` 文档分类，可自行定义。 -- `order` 在当前分类下的展示顺序。 -- `type` 组件类型，特别针对组件文档，目前有 `基本` `表单` `展示` `导航` `其他`。 -- `sketch` 组件对应的视觉源文件下载链接。 -- `chinese` 组件的中文名。 -- `cols` 页面代码演示区块的展示列数，默认为 `2`，对于演示宽度不够的组件可设置为 `1`。 -- `disabled` 使侧边菜单的链接不可点。 - -### 演示文档 - -例如：https://github.com/ant-design/ant-design/blob/e1a6123aa6a4cf47b3be8d681692b7256d4485c6/components/checkbox/demo/controller.md - -- `order` 在当前页面下的展示顺序。 -- `only` 只展示此演示，可以屏蔽其他演示。一般用于线下调试。 -- `hidden` 隐藏此演示区块。 \ No newline at end of file