为了欢迎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
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
开源项目-desertbit-fillpdf.zip 是一个基于Golang语言开发的开源库,专门用于填充PDF表单。在本文中,我们将深入探讨这个库的核心功能、使用方法、优势以及如何将其集成到您的Go项目中。 Fillpdf 提供了一个简单且...
开源项目是指那些源代码可以被免费使用、修改、复制和分发的项目,遵循一定的开源许可协议。Go 语言本身就是开源的,它的源代码可以在 GitHub 上的官方仓库找到。开源特性使得开发者能够查看、学习和贡献代码,促进...
2. **示例代码**(example/*.go):通常开源项目会包含示例代码,展示如何使用Futures来编写异步任务。这将帮助新用户快速上手并理解库的用法。 3. **测试文件**(*_test.go):测试文件用来验证库的功能是否正常...
1. **源代码结构**:通常,开源项目会有一个清晰的目录结构,包括源代码文件(如用Python、Java或JavaScript等编程语言编写的文件)、配置文件、测试文件以及项目文档等。在这个"notes-master"目录下,我们可能看到...
这个项目是用Go语言编写的,因此它利用了Go的强大性能和跨平台特性,使得开发者能够在各种操作系统上处理PDF文档。下面我们将深入探讨该项目涉及的几个关键知识点。 1. **PDF解析**: PDF(Portable Document ...
【开源项目-wolfy-j-goffli.zip】是一个基于Golang编写的开源应用程序,名为Goffli,其主要目的是简化FFmpeg命令的编写过程。FFmpeg是一个强大的跨平台多媒体处理工具,广泛用于视频和音频的转码、剪辑、合并等操作...
3. **文档**:项目可能会提供一份README文件,解释如何安装、配置和使用haigo库,也可能有其他形式的文档来详细介绍库的API和功能。 4. **构建脚本**:用于构建和测试项目的脚本,可能是Makefile或者Golang的go ...
这个开源项目对于那些经常处理Markdown文件且希望在浏览器中预览效果的人来说非常实用,尤其是对于开发者和文档撰写者。同时,由于其开源特性,用户还可以根据自己的需求对其进行定制和改进,或者贡献代码回馈社区。
10. **文档**:尽管这里没有提供具体的文档内容,但一个良好的开源项目通常会提供详尽的README文件,介绍如何安装、配置和使用项目。此外,还可能有API参考文档和示例代码来帮助开发者快速上手。 综上所述,开源...
开源项目-jung-kurt-gofpdf.zip是一个包含Gofpdf库源代码的压缩包,它是一个用Go语言编写的PDF生成器,具有无依赖性的特点。这意味着你可以直接在你的Go项目中使用它,无需安装其他外部库或工具,简化了项目的构建和...
开源项目-salemove-github-review-helper.zip,使用fixup提交和go编写的有用bot改进github评论
【开源项目-posener-complete.zip】是一个基于Go语言编写的开源项目,主要功能是为Bash shell提供自动补全功能。这个项目旨在提升用户在终端使用命令行时的效率,通过智能预测用户可能输入的命令或参数,使得操作...
8. **版本控制系统**:开源项目通常使用Git进行版本控制,项目中可能会有.gitignore文件,定义了哪些文件不被版本系统跟踪。 9. **贡献指南**:为了指导用户和开发者如何参与项目,开源项目可能提供贡献指南,包括...
5. **许可证文件**:开源项目通常会有LICENSE文件,规定了其他人可以如何使用、修改和分发该项目。 使用gotests工具非常简单,通常可以通过以下步骤操作: 1. **安装**:你可以通过`go get`命令在本地安装gotests...
开源项目-feliixx-mgodatagen.zip,为mongodb生成随机bson文档
开源项目-aishraj-golookup.zip,从命令行搜索go包和文档
开源项目的优势在于,它们通常拥有活跃的社区支持,能够持续更新和修复问题,同时也提供了丰富的文档和示例,以便用户学习和应用。 “alistanis-st.zip”中的“st-master”可能指的是项目的主分支或主线版本,这...