godoc2md

command

v0.0.0-...-5c01dc0 Latest Latest Go to latest Published: Feb 18, 2019 License: BSD-3-Clause Imports: 5 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

godoc2md converts godoc formatted package documentation into Markdown format.

Usage

godoc2md $PACKAGE > $GOPATH/src/$PACKAGE/README.md