About

GoDoc hosts documentation for Go packages on Bitbucket, GitHub, Launchpad and Google Project Hosting.

The source code for GoDoc is available on GitHub.

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

Add a package to GoDoc

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

It's important to write a good summary of the package in the first sentence of the package comment. GoDoc indexes the first sentence and displays the first sentence in package lists.

To add a package to GoDoc, search for the package by import path. If GoDoc does not already have the documentation for the package, then GoDoc will fetch the source from the version control system on the fly and add the documentation.

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

GoDoc crawls package imports and child directories to find new packages.

Remove a package from GoDoc

GoDoc automatically removes packages deleted from the version control system when GoDoc checks for updates to the package. You can force GoDoc to remove a deleted package immediately by clicking the refresh link at the bottom of the package documentation page. If you do not want GoDoc to display documentation for your package, send mail to golang-dev@googlegroups.com with the import path of the path of the package that you want to remove.

Feedback

Send your ideas, feature requests and questions to the golang-dev mailing list. Report bugs using the GitHubIssue Tracker.

Plain Text

GoDoc provides plain text output for integration with shell scripts. Use the HTTP Accept header to request a plain text response.

Search for packages with the term 'sql':

$ curl -H 'Accept: text/plain' http://godoc.org/?q=sql

Get the documentation for the standard math package:

$ curl -H 'Accept: text/plain' http://godoc.org/math

Keyboard Shortcuts

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

Bookmarklet

The GoDoc bookmarklet navigates from pages on Bitbucket, GitHub Launchpad and Google Project Hosting to the package documentation. To install the bookmarklet, click and drag the following link to your bookmark bar: GoDoc