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.

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 on the fly and add the documentation.

godocs.io checks for package updates periodically. You can force godocs.io to update the documentation immediately by clicking the refresh button at the bottom of the package documentation page.

To add a badge to your project like this:

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

Remove a package

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.