From 5a1c71677f02405166dbcf23556eebe7d1ccc7bb Mon Sep 17 00:00:00 2001 From: "Zed A. Shaw" Date: Tue, 3 Jun 2025 14:50:59 -0400 Subject: [PATCH] Install godoc for great docs goodness. --- README.md | 20 ++++++++++++++++++++ go.mod | 3 +++ go.sum | 2 ++ 3 files changed, 25 insertions(+) diff --git a/README.md b/README.md index c7cb8a6..3b311a5 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,23 @@ This is a learning projects for me to learn Go. It's a simple website that serves past stream information, a place to post links during stream, and the games I've made while live streaming. + +## Getting godoc To Work + +There's a built-in command `go doc` but there's also a more advanced tool by Google called `godoc`. +I know, amazing naming. Anyway, to get it you do this: + +```shell +go get --tool go.googlesource.com/tools/godoc@latest +``` + +You can then run it and start indexing everything you've installed and _also_ yourprojects packages, +plus get a nice web browser based search page to view the docs: + +```shell +go tool godoc -http=localhost:6060 -index +``` + +> ___NOTE:___ Google doesn't know how the internet works so you have to use `localhost:PORT` and not `127.0.0.1:PORT` when you run this. + +After that it'll take some time to index everything but you can already start browsing the APIs you need, and your project's stuff is in the _Third Party_ section. diff --git a/go.mod b/go.mod index 400e0bb..e28242e 100644 --- a/go.mod +++ b/go.mod @@ -65,6 +65,7 @@ require ( github.com/vertica/vertica-sql-go v1.3.3 // indirect github.com/ydb-platform/ydb-go-genproto v0.0.0-20241112172322-ea1f63298f77 // indirect github.com/ydb-platform/ydb-go-sdk/v3 v3.108.1 // indirect + github.com/yuin/goldmark v1.4.13 // indirect github.com/ziutek/mymysql v1.5.4 // indirect go.opentelemetry.io/otel v1.35.0 // indirect go.opentelemetry.io/otel/trace v1.35.0 // indirect @@ -91,4 +92,6 @@ require ( tool ( github.com/a-h/templ/cmd/templ github.com/pressly/goose/v3/cmd/goose + golang.org/x/tools/cmd/godoc + golang.org/x/tools/cmd/goimports ) diff --git a/go.sum b/go.sum index 697d8c7..4e79e22 100644 --- a/go.sum +++ b/go.sum @@ -243,6 +243,8 @@ github.com/ydb-platform/ydb-go-sdk/v3 v3.108.1/go.mod h1:l5sSv153E18VvYcsmr51hok github.com/youmark/pkcs8 v0.0.0-20181117223130-1be2e3e5546d/go.mod h1:rHwXgn7JulP+udvsHwJoVG1YGAP6VLg4y9I5dyZdqmA= github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= +github.com/yuin/goldmark v1.4.13 h1:fVcFKWvrslecOb/tg+Cc05dkeYx540o0FuFt3nUVDoE= +github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= github.com/ziutek/mymysql v1.5.4 h1:GB0qdRGsTwQSBVYuVShFBKaXSnSnYYC2d9knnE1LHFs= github.com/ziutek/mymysql v1.5.4/go.mod h1:LMSpPZ6DbqWFxNCHW77HeMg9I646SAhApZ/wKdgO/C0= go.mongodb.org/mongo-driver v1.11.4/go.mod h1:PTSz5yu21bkT/wXpkS7WR5f0ddqw5quethTUn9WM+2g=