Generate static Go documentation
Go to file
Trevor Slocum b200d9d2e9 Allow no packages to be specified 2020-02-10 08:07:32 -08:00
.gitignore Initial commit 2020-02-06 08:37:24 -08:00
.gitlab-ci.yml Initial commit 2020-02-06 08:37:24 -08:00
CHANGELOG Allow no packages to be specified 2020-02-10 08:07:32 -08:00
LICENSE Initial commit 2020-02-06 08:37:24 -08:00
README.md Allow no packages to be specified 2020-02-10 08:07:32 -08:00
badge.svg Initial commit 2020-02-06 08:37:24 -08:00
cmd.go Add --exclude flag and fix compilation on Windows 2020-02-07 07:38:30 -08:00
cmd_linux.go Add --exclude flag and fix compilation on Windows 2020-02-07 07:38:30 -08:00
go.mod Initial commit 2020-02-06 08:37:24 -08:00
go.sum Initial commit 2020-02-06 08:37:24 -08:00
main.go Allow no packages to be specified 2020-02-10 08:07:32 -08:00
page.go Add --site-footer flag 2020-02-08 07:10:03 -08:00

README.md

godoc-static

CI status Donate

Generate static Go documentation

Demo

Rocket Nine Labs Documentation

Installation

Install godoc-static:

go get gitlab.com/tslocum/godoc-static

Also install godoc:

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

Documentation

Execute godoc-static supplying at least one package name to generate documentation for specific packages:

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

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

Missing packages are not downloaded automatically.

Options

-base-path

Site relative URL path with trailing slash.

-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.

-verbose

Enable verbose logging.

Usage examples

Generate documentation for archive, net/http and gitlab.com/tslocum/cview targeting https://docs.rocketnine.space:

godoc-static -base-path=/ -site-name="Rocket Nine Labs Documentation" \
    -site-description="Welcome!" \
    -destination=/home/user/sites/docs \
    archive net/http gitlab.com/tslocum/cview

Targeting https://rocketnine.space/docs/:

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

Support

Please share issues/suggestions here.