godochtml

command

v0.0.15 Latest Latest Go to latest Published: Jun 16, 2020 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Command godochtml generates package documentation as HTML.

The output is very close to (but not exactly same as) godoc. The generated HTML is simple static HTML but includes syntax highlighting.

Usage: godochtml [options] "package or package directory"

  -src fileregexp=url -- use this to make types and functions
links.

Example:

godochtml \
  -src 'github.com/([^/]*)/([^/]*)(.*)=https://github.com/$1/$2/blob/master$3' \
  github.com/tvastar/gotools/cmd/godochtml

The generated HTML is written to console.