package
0.0.0-20240107094241-3b473a0075bd
Repository: https://github.com/efficientgo/examples.git
Documentation: pkg.go.dev
# README
Example showcasing Go documentation with godoc
.
Read more in "Efficient Go"; Example 2-9.
Usage
Prerequisite: go
installed.
- Pull the repo on local machine.
- Go to the directory where this README exists.
- Run
make
. This will triggergodoc
installation on your local machine. Then it will startgodoc
in serving mode that serves documentation on port 6060. - Once you see "using module mode; ...", go to
localhost:6060
in your browser. You see all available modules on your machine, including standard library. Forpkg/godoc
package see http://localhost:6060/pkg/github.com/efficientgo/examples/pkg/godoc/.
# Functions
Download downloads directory that is meant to be block directory.
# Constants
MetaFilename is the known JSON filename for meta information.