为了欢迎google回归中国, 我发起了一个叫做bestpaper的项目
[url]http://code.google.com/p/bestpaper/[/url],
目的是使用googlecodewiki和一些额外的扩充,用纯文本编写和维护技术文档.
使用方法参见
[url]http://code.google.com/p/bestpaper/wiki/quickstart[/url].
ps:
附上wiki示例文件和翻译后的Pdf.
wiki文件:
- 介绍 -bestpaper(bp)是一个非盈利性开源项目.= 目标 =bp致力于简化编写和维护技术文档, 希望在仅有文本编辑器的时候也能简便的编写各种图文并茂的文档.= 基本功能 === 排版 ==bp仅使用少量排版符号,如标题,段落缩进,表格等;== 图片 ==bp希望根据特定文本可生成图片,如根据某个目录下的java代码生成class diagram;== 插件化 ==bp希望某些资源能被很方便的分享,如在文档内输入淘宝的商品url能生成商品的详细展示;bp希望有更多的文档生成功能可以插件化扩充.- 语法 -排版使用googlecodewiki语法的子集图像生成未来支持umlgraph, seqence diagram editor, dot等语法,支持oembed等协议= 表格 = || *名词* || *说明* || *示例* |||| isv || software vendor || bestpaper ||= 文字 =Text in *bold* or _italic_ or ~~strike~~_italic is not italic*bold is not bold~~strike is not strike= 图片 =gif: [../images/gif.gif]- 设计 -= class diagram =- A&Q -A: Why not docbook?Q: docbook采用xml语法,手写起来复杂且格式太过丰富. 也没有其他插件化的功能(如图片生成)