Updated 文档和演示 Markdown 文件的各类功能配置说明 (markdown)

Benjy Cui 2016-10-19 15:21:09 +08:00
parent 6ffd31afef
commit 45d21bd5d3
2 changed files with 34 additions and 33 deletions

@ -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` 使侧边菜单的链接不可点。

@ -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` 隐藏此演示区块。