Generate static Go documentation
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Trevor Slocum 9b6238517c Add --quiet option 5 months ago
.gitignore Initial commit 2 years ago
CHANGELOG Add --quiet option 5 months ago
LICENSE Initial commit 2 years ago
README.md Add --quiet option 5 months ago
badge.svg Initial commit 2 years ago
cmd.go Add --exclude flag and fix compilation on Windows 2 years ago
cmd_linux.go Add --exclude flag and fix compilation on Windows 2 years ago
go.mod Add --quiet option 5 months ago
go.sum Add --quiet option 5 months ago
main.go Add --quiet option 5 months ago
page.go Add code.rocketnine.space migration notice 6 months ago

README.md

godoc-static

CI status Donate

Generate static Go documentation

Demo

Rocket Nine Labs Documentation

Installation

Install godoc-static:

go get code.rocketnine.space/tslocum/godoc-static

Also install godoc:

go get golang.org/x/tools/cmd/godoc

Documentation

To generate documentation for specific packages, execute godoc-static supplying at least one package import path and/or absolute path:

godoc-static -destination=/home/user/sites/docs fmt net/http ~/awesomeproject

When an import path is supplied, the package is sourced from $GOPATH or $GOROOT.

When no packages are supplied, documentation is generated for packages listed by go list ....

Packages are not downloaded/updated automatically.

Usage examples

Generate documentation for archive, net/http and ~/go/src/code.rocketnine.space/tslocum/cview:

godoc-static \
    -site-name="Rocket Nine Labs Documentation" \
    -site-description-file=/home/user/sitefiles/description.md \
    -destination=/home/user/sites/docs \
    archive net/http code.rocketnine.space/tslocum/cview

Options

-destination

Path to write site to.

-exclude

Space-separated list of packages to exclude from the index.

Link to index.html instead of folder.

-listen-address

Address for godoc to listen on while scraping pages.

-site-description

Site description (markdown-enabled).

-site-description-file

Path to markdown file containing site description.

Site footer (markdown-enabled).

Path to markdown file containing site footer.

-site-name

Site name.

-quiet

Disable all logging except errors.

-verbose

Enable verbose logging.

-zip

Site ZIP file name.

Support

Please share issues and suggestions here.