Golang Ruby 搭建本地 Golang 文档服务器

frankking · 发布于 2016年3月12日 · 最后由 frankking 回复于 2016年3月12日 · 1078 次阅读
16139

平时我们看 golang 文档的方式通常有:

  1. go doc <package>
  2. golang.org/pkg 或者国内的 godoc.golangtc.com/pkg/
  3. 看源码,当然这是最好的方式,只是需要更多的时间和耐心。

如果没有网络,我一般会选择 方式1 + 方式3,但缺点是可读性差。

后来了解到,godoc -html <package> 可以生成 HTML 文档,所以就思考如何搭建本地的 localhost:3000/pkg

先取个名字,godocserver

步骤如下:

  1. 获取所有 golang built-in packages 名称
  2. 遍历所有 packages 运行 godoc -html <package>
  3. 保存所有文件,启动一个静态文件服务器

利用 Ruby 实现 步骤1、2,要注意遍历 $GOPATH/src/ 时要过滤一些不需要的目录,创建文件时,要先创建对应的目录。

启动静态服务器用 golang 和 ruby 都可以,我用的是 negroni,就三行代码。

问题是,这样的页面完全没有样式啊,所以我不得不去 golang.org/pkg 上 copy css 和 js 文件。

然后将 Index 的样式修改成这样: show.png

最后实现 package 导航: nav.png

这个功能我们需要知道所有已存文档的名称,所以我们需要维护一个文件 all_documents.json 供前端使用,然后我们需要做一个带有过滤功能的列表。这里用 Vue.js 作双向数据绑定(好用,好用,好用)。

至此,我们就可以愉快的在本地看 golang 文档啦。

更多阅读:

godocserver 项目地址

Vuejs 初试

共收到 2 条回复
5907

一般使用 godoc 命令来搭建本地文档服务(页面功能跟 https://golang.org 是一样的,并且还包含本地安装的第三方包的文档):

  1. go get golang.org/x/tools/cmd/godoc
  2. godoc -http=:6060
  3. 浏览器访问 http://localhost:6060
16139

#1楼 @mozillazg 好吧,有点尴尬

需要 登录 后方可回复, 如果你还没有账号请点击这里 注册