godocdoc

command module
v0.0.0-...-065d112 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 8, 2021 License: MIT Imports: 12 Imported by: 0

README

godocdoc

godocdoc is a dumb wrapper around Godoc that does two things:

  1. Starts godoc
  2. Waits for godoc to listen on a port, then opens the doc URL in a web browser

If the working directory is in the GOPATH, godocdoc will open the browser to the location of the current package, i.e. http://localhost:6060/pkg/github.com/kevinburke/godoc.

Configuration

You can change the port by passing --port=<port> to godocdoc. The godoc binary has a number of formatting options, which are all currently ignored.

Documentation

Overview

godocdoc is a tool for browsing Go documentation.

Usage:

godocdoc [-port PORT]

This will start the godoc binary, wait for it to listen on the specified port, and when it is listening, open a browser tab to the package you are currently looking at. It's useful for opening the documentation for the project you're currently examining in the terminal.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL