为了欢迎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语法,手写起来复杂且格式太过丰富. 也没有其他插件化的功能(如图片生成)
分享到:
相关推荐
【标题】"开源项目-frou-GoFeather.zip" 提供了一个名为 GoFeather 的开源项目,它是专为 Sublime Text 编辑器设计的一个增强型 Go 语言模式。GoFeather 强调了对 `go doc` 快捷查询和 godoc.org 在线文档检索的支持...
10. **文档编写**:良好的开源项目会有详尽的文档,包括安装指南、API参考、示例代码等,帮助新用户快速上手。Markdown格式的README文件是常见的入门文档形式。 总之,开源项目-jzelinskie-faq.zip 可能是一个以...
这个项目是用Go语言编写的,因此它利用了Go的强大性能和跨平台特性,使得开发者能够在各种操作系统上处理PDF文档。下面我们将深入探讨该项目涉及的几个关键知识点。 1. **PDF解析**: PDF(Portable Document ...
3. **文档**:项目可能会提供一份README文件,解释如何安装、配置和使用haigo库,也可能有其他形式的文档来详细介绍库的API和功能。 4. **构建脚本**:用于构建和测试项目的脚本,可能是Makefile或者Golang的go ...
这个开源项目对于那些经常处理Markdown文件且希望在浏览器中预览效果的人来说非常实用,尤其是对于开发者和文档撰写者。同时,由于其开源特性,用户还可以根据自己的需求对其进行定制和改进,或者贡献代码回馈社区。
8. **版本控制系统**:开源项目通常使用Git进行版本控制,项目中可能会有.gitignore文件,定义了哪些文件不被版本系统跟踪。 9. **贡献指南**:为了指导用户和开发者如何参与项目,开源项目可能提供贡献指南,包括...
5. **许可证文件**:开源项目通常会有LICENSE文件,规定了其他人可以如何使用、修改和分发该项目。 使用gotests工具非常简单,通常可以通过以下步骤操作: 1. **安装**:你可以通过`go get`命令在本地安装gotests...
开源项目-aishraj-golookup.zip,从命令行搜索go包和文档
开源项目-feliixx-mgodatagen.zip,为mongodb生成随机bson文档
开源项目-posener-complete.zip,在go中编写bash完成的工具
开源项目-flowup-cloudfunc.zip,部署用go编写的google云功能
10. **文档编写**:好的开源项目需要有清晰的文档,包括README、API文档和教程,帮助其他开发者理解和参与项目。 通过研究Boohu项目,开发者不仅可以提升Go语言和游戏开发技能,还能深入了解开源社区的运作模式,...
开源项目-mingrammer-flog.zip,用go编写的通用日志格式的假日志生成器
开源项目-goreleaser-nfpm.zip,nfpm生成deb和rpm包,并用go编写
综上所述,go-cloudfile 是一个使用 Go 语言编写的开源项目,它为开发者提供了一种通用的方式来处理远程文件系统,简化了跨云平台的文件操作。通过这个项目,开发者可以更高效、一致地与各种云存储服务交互,而无需...
开源项目-ory-am-hydra#-.zip,运行自己的低延迟go oauth2和openid connect provider
开源项目-jung-kurt-gofpdf.zip 是一个包含Gofpdf库源代码的压缩包,这个库是用Go语言编写的,专为生成PDF文档而设计。它的一大特点是无需依赖其他外部库,使得在各种环境中集成和使用变得更加简单。Gofpdf通过提供...
【标题】:“开源项目-fern4lvarez-go-metainspector.zip” ...通过这个开源项目,开发者不仅可以学习到如何使用Go语言进行网络编程,还可以了解到Web数据抓取的基本原理和技术,以及如何在开源社区中协作和贡献。
10. **文档编写**:开源项目通常重视文档,使用如Markdown格式的README文件介绍项目背景、使用方法、贡献指南等。icholy-gosearch也应该有详细的文档指导用户如何安装、运行和定制这个搜索工具。 总的来说,...
开源项目-containous-traefik.zip,Traefik has now native support to Prometheus, AWS ECS, Rancher and Netflix Eureka in v1.2.0-rc1!