搭建本地 golang 文档服务器
时间:2022-05-04
本文章向大家介绍搭建本地 golang 文档服务器,主要内容包括其使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。
平时我们看 golang 文档的方式通常有:
go doc <package>
- golang.org/pkg 或者国内的 godoc.golangtc.com/pkg/
- 看源码,当然这是最好的方式,只是需要更多的时间和耐心。
如果没有网络,我一般会选择 方式1 + 方式3,但缺点是可读性差。
后来了解到,godoc -html <package>
可以生成 HTML 文档,所以就思考如何搭建本地的 localhost:3000/pkg
先取个名字,godocserver
步骤如下:
- 获取所有 golang built-in packages 名称
-
遍历所有 packages 运行
godoc -html <package>
- 保存所有文件,启动一个静态文件服务器
利用 Ruby 实现 步骤1、2,要注意遍历 $GOPATH/src/
时要过滤一些不需要的目录,创建文件时,要先创建对应的目录。
启动静态服务器用 golang 和 ruby 都可以,我用的是 negroni,就三行代码。
问题是,这样的页面完全没有样式啊,所以我不得不去 golang.org/pkg 上 copy css 和 js 文件。
然后将 Index 的样式修改成这样:
最后实现 package 导航:
这个功能我们需要知道所有已存文档的名称,所以我们需要维护一个文件 all_documents.json 供前端使用,然后我们需要做一个带有过滤功能的列表。这里用 Vue.js 作双向数据绑定(好用,好用,好用)。
至此,我们就可以愉快的在本地看 golang 文档啦。
- kvm虚拟化管理平台WebVirtMgr部署-虚拟化环境安装-完整记录(0)
- ruby学习笔记(3)--语法层面的先见之明
- jQuery操作Select
- ruby学习笔记(11)--symbol与hash参数
- zabbix监控-基本原理介绍
- OpenStack构架知识梳理
- mysql操作命令梳理(4)-grant授权和revoke回收权限
- 问未来
- ruby on rails + mysql 开发环境搭建
- CentOS 7.2下安装Mono 5.0
- ROR学习笔记(1):Rails 2快速创建GRUD应用
- API网关Ocelot 使用Polly 处理部分失败问题
- 使用GoogleAPI加载各种js框架
- Docker容器学习梳理--日常操作总结
- JavaScript 教程
- JavaScript 编辑工具
- JavaScript 与HTML
- JavaScript 与Java
- JavaScript 数据结构
- JavaScript 基本数据类型
- JavaScript 特殊数据类型
- JavaScript 运算符
- JavaScript typeof 运算符
- JavaScript 表达式
- JavaScript 类型转换
- JavaScript 基本语法
- JavaScript 注释
- Javascript 基本处理流程
- Javascript 选择结构
- Javascript if 语句
- Javascript if 语句的嵌套
- Javascript switch 语句
- Javascript 循环结构
- Javascript 循环结构实例
- Javascript 跳转语句
- Javascript 控制语句总结
- Javascript 函数介绍
- Javascript 函数的定义
- Javascript 函数调用
- Javascript 几种特殊的函数
- JavaScript 内置函数简介
- Javascript eval() 函数
- Javascript isFinite() 函数
- Javascript isNaN() 函数
- parseInt() 与 parseFloat()
- escape() 与 unescape()
- Javascript 字符串介绍
- Javascript length属性
- javascript 字符串函数
- Javascript 日期对象简介
- Javascript 日期对象用途
- Date 对象属性和方法
- Javascript 数组是什么
- Javascript 创建数组
- Javascript 数组赋值与取值
- Javascript 数组属性和方法