# 智能小程序文档编写指导&规范
## 如何编写
### 开启预览
进入 swan-docs，终端执行 `npm start`;
终端看到`Hexo is running at http://localhost:4000/docs/. Press Ctrl+C to stop.` 提示，启动成功。
访问 http://localhost:4000/docs/introduction/register/ 开始编辑（path与线上一致）。
### 编写
编辑器打开模块，找到你要编辑的文档所在文件夹，修改刷新浏览器即可看到修改。
#### 新增文档
如果是新增文档，去到`source/_data/nav.yml`新增一份配置（nav.yml配置说明见编写规范）。然后到对应的目录下建立一个.md。
## 编写规范
### 导航配置
这分配置相当于书的目录。
第一层级为header导航栏，第二层级为左侧导航，第三层级为左侧导航子导航。
nav.yml 例子如下
```
-
link: /design/principle
text: 设计
name: design
nav:
-
link: /design/principle
text: 智能小程序设计指南
name: book
sidebar:
-
link: /design/principle
text: 设计原则
name: principle
-
link: /design/specification
text: 样式规范
name: specification
-
link: /design/component
text: 组件
name: component
```
### 文档编写规范
·····待补充
## 定制模版
在.md文件中可以引入定制模版按参数替换即可
### 下载模版
```
```
参数
{链接左} 替换成下载链接
{链接右} 替换成下载链接
{图片左} 替换成图片地址
{图片右} 替换成图片地址
{文案左} 替换成文案说明
{文案右} 替换成文案说明
### 双图模版 & 三图模版
```
{待选模版}
// 待选模版
```
参数
{图片} 替换成图片地址
{待选模版} 两图就复制两个待选模版进去，三图就复制三个待选模版进去，将`{图片}`替换要展示图片地址。
### 左图右文模版
```
// 待选模版1
{标题文案}
// 待选模版2
{加粗文案}
// 待选模版3
{普通文案}
// 待选模版4
```
### 示例模版
```
{待选模版}
// 待选模版
{高亮文案}
{解释说明}