Generate static Go documentation
Go to file
Trevor Slocum 6d46d82f22 Add --site-footer flag 2020-02-08 07:10:03 -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 Add --site-footer flag 2020-02-08 07:10:03 -08:00
LICENSE Initial commit 2020-02-06 08:37:24 -08:00
README.md Add --exclude flag and fix compilation on Windows 2020-02-07 07:38:30 -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 Add --site-footer flag 2020-02-08 07:10:03 -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 with the -help flag for more information.

Usage examples

Generate documentation for archive, fmt and net/http targeting https://docs.rocketnine.space:

godoc-static -base-path=/ -site-name="Rocket Nine Labs Documentation" \
    -site-description="Welcome!" \
    -out=/home/user/sites/docs \
    archive fmt net/http

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

godoc-static -base-path=/docs/ -site-name="Rocket Nine Labs Documentation" \
    -site-description-file=/home/user/sitefiles/description.md \
    -out=/home/user/sites/docs \
    archive fmt net/http

Support

Please share issues/suggestions here.