gddo

module

v0.0.0-...-55358d4 Latest Latest Go to latest Published: Jan 24, 2024 License: BSD-3-Clause

Details

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.

First install the dependencies:

Then compile and install:

$ make
# make install

Initialize the PostgreSQL database:

psql -f schema.sql

Then run:

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

See gddo --help for all available flags.

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.

Send them to the mailing list.

Path	Synopsis
cmd
gddo Command gddo fetches and serves documentation for Go programs.	Command gddo fetches and serves documentation for Go programs.
internal
autodiscovery Package autodiscovery implements the [VCS Autodiscovery RFC].	Package autodiscovery implements the [VCS Autodiscovery RFC].
database Package database manages the storage of documentation.	Package database manages the storage of documentation.
godoc Package godoc is for rendering Go documentation.	Package godoc is for rendering Go documentation.
godoc/codec Package codec implements the general-purpose part of an encoder for Go values.	Package codec implements the general-purpose part of an encoder for Go values.
httputil Package httputil provides HTTP utility functions.	Package httputil provides HTTP utility functions.
proxy Package proxy provides support for fetching modules from a Go module proxy.	Package proxy provides support for fetching modules from a Go module proxy.
render Package render implements rendering of Go code.	Package render implements rendering of Go code.
server Package server implements the Go documentation server.	Package server implements the Go documentation server.
stdlib Package stdlib supports special handling of the Go standard library.	Package stdlib supports special handling of the Go standard library.
static