About

This is a fork of gddo, the software which previously powered the now-defunct godoc.org. The source code is available on sr.ht.

Documentation

godocs.io generates documentation from Go source code. The guidelines for writing Go documentation apply.

It's important to write a good summary of the package in the first sentence of the package comment. godocs.io indexes the first sentence and displays it in search results.

Add a package

To add a package to godocs.io, search for the package by import path. If godocs.io does not already have the documentation for the package, it will fetch the package source code from the Go module proxy on the fly.

godocs.io checks for module updates periodically. You can force godocs.io to check for updates by clicking the refresh button at the bottom of the package documentation page. If that doesn't work, it's possible that the module proxy doesn't know about the update yet. You can try fetching the module with 'go get' to force the module proxy to check for updates.

Tools for package owners

To add a badge to your project like this:

Click on "tools" for package owners at the bottom of the documentation page.

Keyboard shortcuts

godocs.io has keyboard shortcuts for navigating package documentation pages. Type '?' on a package page for help.