为了欢迎google回归中国, 我发起了一个叫做bestpaper的项目
http://code.google.com/p/bestpaper/,
目的是使用googlecodewiki和一些额外的扩充,用纯文本编写和维护技术文档.
使用方法参见
http://code.google.com/p/bestpaper/wiki/quickstart.
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语法,手写起来复杂且格式太过丰富. 也没有其他插件化的功能(如图片生成)
分享到:
相关推荐
分享6个国内优秀Java后台管理框架的开源项目-建议收藏!.pdf
Grails-开源框架---使用指南.pdf与Groovy入门经典(中文) ,2本书生成Grails代码骨架,用Groovy开发,同时兼容JAVA语言
开源项目-quii-learn-go-with-tests.zip,Learn Go by writing tests - Hello, world
java开源项目-使用Java开源工作流jBPM开发一个简单的
开源项目-github-git-lfs.zip,git大文件存储是用go编写的
开源项目-lukasmartinelli-pipecat.zip,用go编写的unix管道连接消息队列的实用程序
开源项目-pazams-go-for-javascript-developers.zip,pazams/go-for-javascript-developers
开源项目-abice-go-enum.zip,基于文档注释生成go枚举
开源项目-mattn-anko.zip,用go编写的脚本解释器
开源项目-matcornic-hermes.zip,Hermes – Golang package that generates clean, responsive HTML e-mails
开源项目-chrislusf-gleam.zip,在pure-go-on-gleam中编写分布式映射器缩减器
react-native-html-to-pdf, 将html字符串转换为PDF文档 react-native-html-to-pdf将html字符串转换为PDF文档安装运行 npm install react-native-html-to-pdf --save选项 1: 自动运行 react-native
前端开源库-html-pdf使用phantomjs的html-pdf、html-to-pdf转换器
开源项目-Vertamedia-chproxy.zip,go编写的灵活clickhouse代理
开源项目-hortonworks-cloud-haunter.zip,用go编写的开源多云看门人工具
开源项目-piglei-lbssh.zip,一个简单的工具,用于快速搜索和ssh到用go编写的远程服务器
开源项目-alexedwards-scs.zip,alexedwards/scs: Session management for Go 1.7
开源项目-PennTex-commuter.zip,在Go中编写的用于帮助处理通勤信息的CLI工具