Skip to content

Instantly share code, notes, and snippets.

@ym
Last active December 27, 2015 01:29
Show Gist options
  • Save ym/7245748 to your computer and use it in GitHub Desktop.
Save ym/7245748 to your computer and use it in GitHub Desktop.

关于

Go Walker 用于为托管在版本控制系统上的 Go 开源项目生成在线 API 文档,目前支持的平台包括 BitbucketGithubGoogle CodeLaunchpadGit @ OSC

对于 Go 标准库Go 官方维护库 和命令行项目, Go Walker 提供基于源文件的代码视图。

您可以在 Github(稳定版)或 Git @ OSC(测试版)上浏览并下载该项目的源代码。

由于 Go Walker 使用 Nginx 作为前端代理,当您进行刷新文档、增加示例或任何导致页面内容改变的操作,您可能需要使用 F5command + r 进行强制刷新。

添加新的项目到 Go Walker

Go Walker 是一个用于生成 Go 项目 API 文档的服务器,有关文档注释规范,请参考官方给出的 大纲。Go 步行者兼容所有 godoc 工具所支持的标准,同时 Go Walker 还将会显示类型在不同包之间的关联。

对于一个具有良好可读性的项目而言,规范完整的文档说明是极其重要的。Go Walker 会截取每个项目的包的首行文字作为该包的纲要,并在搜索项目时展现给阅读者。

如果您打算将某个项目添加到 Go Walker,可以通过 搜索 该项目的导入路径来通知服务器。如果该项目的文档已经存在,则将直接呈现给您,否则会从相关的版本控制系统上即时下载并生成文档。如果您的操作是添加新的项目,则最多可能需要 5 秒的时间来完成,因为 Go Walker 会将源码和文档展示在相同页面上。

Go Walker 每天都会检查各个项目的更新情况,你也可以通过底部的刷新按钮来进行强制刷新。

在 README 中添加徽章

Go Walker

只要将 [![Go Walker](http://gowalker.org/api/v1/badge)](http://gowalker.org/github.com/Unknwon/com) 放置进去即可。

从 Go Walker 中删除项目

Go Walker 将会在每日检查更新时自动删除更新失败的项目,您也可以在删除托管在版本控制系统上的项目后,通过强制刷新的方式来完成删除操作。

如果您只是单纯的想要禁止他人通过本服务器产生您的项目源码文档,请通过 Open Issue 的方式提出。

控制面板

Go Walker 提供控制面板以方便页面上的操作,在文档页面按下问号 "?" 即可打开控制面板。感谢 chenwenli 提供的帮助!

为项目增加示例

在相应的文档页面按下 g + e 然后输入 GitHub Gist 地址,示例 Gist 可以在 这里 找到。

协助站点翻译

Go Walker 支持多语言的网站用户界面。您可以通过翻译 "conf/message.ini" 文件来帮助站点支持您所使用的语言。

多语言文档

如果您的项目目录包含 readme(.md) 文件,Go 步行者将会使用 readme(.md) 作为英文版本,readme_zh|cn 作为中文版本,并根据用户语言选项自动展示它们。

反馈

如果您有好的建议或想法,请发送邮件到 joe2010xtmf#163.com。网站问题反馈请通过 Github Issue Tracker

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment