~sircmpwn/gddo

Fork of godoc.org
internal/proxy: Compute stdlib latest version
Update dependencies
Update go.mod to Go 1.21

clone

read-only
https://git.sr.ht/~sircmpwn/gddo
read/write
git@git.sr.ht:~sircmpwn/gddo

You can also use your local clone with git send-email.

#gddo

Go Documentation

gddo is a maintained fork of the software that once powered godoc.org, and you can use it to browse documentation for Go packages.

A hosted instance is available at godocs.io.

#Installation

First install the dependencies:

  • Go 1.19 or above

Then compile and install:

$ make
# make install

#Running

Initialize the PostgreSQL database:

psql -f schema.sql

Then run:

gddo \
	--db "postgres://localhost" \
	--http :8080

See gddo --help for all available flags.

#Gemini support

gddo can also serve documentation over the Gemini protocol.

To serve documentation over Gemini only, run:

gddo --gemini :1965 --certs /var/lib/gemini/certs --hostname example.com

See the documentation for more information.

#Questions? Patches?

Send them to the mailing list.