Light

marwan-at-work / moddoc Goto Github PK

View Code? Open in Web Editor NEW

33.0 3.0 1.0 43.71 MB

A GOPROXY Documentation Generator

Dockerfile 0.28% Go 86.37% CSS 4.55% HTML 8.80%

go golang modules godoc

moddoc's Introduction

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

~ 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/<module>/@v/<version> to see a documentation package directly. For example, http://localhost:3001/github.com/pkg/errors/@v/v0.8.1

Demo

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

moddoc's People

Contributors

Stargazers

Watchers

Forkers

zeeke

moddoc's Issues

Include clickable type information in signatures

Have the ability to click on a type in a function signature, and go to that type.

Support multi GOPROXY URLS

Currently ModDoc just takes the first value of a comma-separated GOPROXY variable. However, it should work similar to the Go command in that it will try all GOPROXY variables when the previous one returns a 404/status-gone.

paginate index page

Enhances the home page search as hitting it once does not guarantee all modules to be retrieved

Large repos freeze

Some large repos freeze.

Server side rendering should remove this overhead.

include runnable example

similar to godoc, Example tests should be displayed and ideally runnable.

better error with multi-element GOPROXY

I ran moddoc with GOPROXY=https://proxy.golang.org/,direct, and I see errors like Error while retrieving catalog from proxy: [unexpected status: 400].

Perhaps moddoc should fail fast when it sees a GOPROXY value like this.

Some files are included as sub-directories

Some packages show .gitignore as subdirectories, those should be skipped.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.