用多种语言创建示例api文档
flockdoc的Python项目详细描述
==
>用多种语言创建示例api文档(比如[stripe s的api
docs][stripeapi])
[stripeapi:http://stripe.com/docs/api
<
=
=
==
==
==
==
=
<
===============测试.py
这是一项测试。rb
–––docs
–––index.md
––布局
–––index.html
––静态
––静态
––布局
–––布局
––布局
––index.html
––index.html
––一些img.jpg
–(大致地)将它转换成(大致地)这个目录结构:
/>
/>––––––––––>——test.py.html
——test.rb.html
——index.html
——static
——一些img.jpg
——styles.css
flockdoc将尽力为您处理
格式。输出看起来有点像[docco][docco]。
带标记正文的Yaml标题。示例:
title:test
context:
key:value
--
这是一个测试文档,具有一个键:{{key}
文档在输出之前通过Jinja2呈现进行传递。
[docco]:http://jashkenas.github.io/docco/
[jekyll]:http://jekyllrb.com/