https://github.com/marwan-at-work/moddoc
A GOPROXY Documentation Generator
https://github.com/marwan-at-work/moddoc
go godoc golang modules
Last synced: 6 months ago
JSON representation
A GOPROXY Documentation Generator
- Host: GitHub
- URL: https://github.com/marwan-at-work/moddoc
- Owner: marwan-at-work
- Created: 2019-03-22T04:51:25.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-22T00:29:10.000Z (about 5 years ago)
- Last Synced: 2025-03-22T12:24:29.000Z (7 months ago)
- Topics: go, godoc, golang, modules
- Language: Go
- Homepage:
- Size: 42.7 MB
- Stars: 33
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# moddoc
This is a server that takes a GOPROXY url as an argument and gives you a UI documentation similar to godoc.org except all data comes from the GOPROXY and not from VCS.
If your GOPROXY supports a /catalog endpoint, then you can see and search the list of existing modules on the home page.
## Quick start
```bash
~ GO111MODULE=on go install marwan.io/moddoc
# Assuming you have a GOPROXY server running at http://localhost:3000
~ GOPROXY=http://localhost:3000 moddoc
```
Visit http://localhost:3001
You can also visit `http://localhost:3001//@v/` to see a documentation package directly.
For example, http://localhost:3001/github.com/pkg/errors/@v/v0.8.1
## Demo
[
](https://vimeo.com/325806835)
## Status
This program was meant as a temporary workaround until the Go team launched their own Module aware doc website.
Now that they have, please feel free to use the more fully featured https://pkg.go.dev