doccito 0.1.4

## 安装 ##

使用pip安装lib

pip install doccito

- 或者 -

将“doccito” 目录 放置在您的python路径中的某个位置

## 使用方法 ##

Doccito通过读取readme.markdown文件，并构建一个包含文档标签的目录的HTML页面，允许您为项目快速轻松地生成文档。

更多Markdown语法和示例可以在Markdown网站上找到，http://daringfireball.net/projects/markdown/syntax。

### 命令行参数 ###

在命令行上运行Doccito允许您使用提供的base.html页面或使用[–template]命令自定义的页面。

不使用任何参数运行Doccito将显示其帮助菜单，带有可选参数

-h，--help

显示帮助信息并退出

--stdio

指定stdio

--template

指定自定义HTML模板

--version

显示程序版本号并退出

cat README.markdown | python doccito.py –stdio > docs.html

- 或者 -

python doccito.py README.markdown > docs.html

将读取README.markdown文件，将其放入默认的base.html模板，并创建并发送到docs.html。

cat README.markdown | python doccito.py –stdio –template layout.html > docs.html

将使用layout.html作为模板。

##API##

使用Doccito作为库允许使用多个功能

###doccito.create_docs###

• input 是包含文档的 .markdown 字符串

• template 是要使用的 .html 模板（可选）

示例用法

import doccito

doccito.create_docs(input, template="./base.html")