Overview

The integrated Godoc viewer in LiteIDE provides an easy way to browse documentation generated by the godoc tool without leaving the editor. Documentation can be viewed for both the official Go language as well as custom packages. The remainder of this page describes ways to invoke the Godoc viewer.

Supported URL Schemes

It is possible to view documentation by directly entering a URL into the Godoc viewer's address bar. When doing this, you can specify what type of documentation you are looking for by prefixing the address with one of the following URL schemes:

find

Searches for packages with a specified string in their name. For example:

list

Lists all packages in a given directory. The main choices are "pkg" and "cmd", which can be found as links in the header of the page. For example:

pdoc

Views documentation for a specified package or command. For example:

file

Views a specified HTML, Markdown, or plain-text file. For example:

Automatic Schemes

For the "file" and "pdoc" schemes, you do not need to type the scheme as part of the URL. For example:

File Browser

You can open the Godoc viewer directly from the file browser by right clicking on a file or directory and selecting "View Godoc Here". The Godoc viewer will automatically open the package documentation for the chosen item.