About

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

godocs.io displays documentation for GOOS=linux unless otherwise noted at the bottom of the documentation page.

Add a package to godocs.io

godocs.io generates documentation from Go source code. The guidelines for writing documentation for the godoc tool apply to godocs.io.

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 the first sentence in package lists.

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, then godocs.io will fetch the source from the version control system on the fly and add the documentation.

godocs.io checks for package updates once per day. You can force godocs.io to update the documentation immediately by clicking the refresh link at the bottom of the package documentation page.

godocs.io crawls package imports and child directories to find new packages.

Remove a package from godocs.io

If you do not want godocs.io to display documentation for your package, send mail to sir@cmpwn.com with the import path of the path of the package that you want to remove.

Keyboard Shortcuts

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