tslocum/godoc-static
tslocum/godoc-static
1
0
Fork 2
Code Issues 2 Pull requests Releases Activity
Generate static Go documentation
1 commit 1 branch 14 tags 80 KiB
Go 100%
Find a file
Trevor Slocum 59a830aadf Initial commit
2020-02-06 08:37:24 -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
badge.svg Initial commit 2020-02-06 08:37:24 -08:00
CHANGELOG Initial commit 2020-02-06 08:37:24 -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
LICENSE Initial commit 2020-02-06 08:37:24 -08:00
main.go Initial commit 2020-02-06 08:37:24 -08:00
page.go Initial commit 2020-02-06 08:37:24 -08:00
README.md Initial commit 2020-02-06 08:37:24 -08:00

README.md

godoc-static

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