Trevor Slocum 6387f68699 | ||
---|---|---|
.gitignore | ||
.gitlab-ci.yml | ||
CHANGELOG | ||
LICENSE | ||
README.md | ||
badge.svg | ||
cmd.go | ||
cmd_linux.go | ||
go.mod | ||
go.sum | ||
main.go | ||
page.go |
README.md
godoc-static
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.