bdcontract-doc/文档编写说明.txt

# 开发环境安装：

pip install sphinx

# 配置文件说明

./source/index.rst
./source/conf.py

# 编写文档

前往source/markdown目录，修改xxx.md文件。

## 转换成rst，并生成html。

在./doc/目录下，执行：
```bash
sh toRst.sh
```

##


# MarkDownTips

1)学习markdown:https://www.runoob.com/markdown/md-tutorial.html
2)可参考现有.md文件作为模板。
3)表格示例：
| 字段   | 值                                |
| ------ | --------------------------------- |
| action | startContract                     |
| script | 合约脚本内容, 需进行进行URIEncode |

4)代码示例：
特别地，json代码的格式化可以使用：http://www.bejson.com/t2ck.htm
```json
{
    "data": "{\"status\":\"Success\",\"result\":\"\"}",
    "action": "onStartContract",
    "cid": "-562752842",
    "executeTime": 1187
}
```
5)插入图片示例：
![shortcut2](./_static/imgs/shortcut2.png)
方括号内为小标题，小括号内为“图片的相对路径”，一定不要写成绝对路径。

6)超链接：
[百度](http://baidu.com)