godoc2md

command module

v0.0.0-...-849bc75 Latest Latest Go to latest Published: Aug 16, 2024 License: BSD-3-Clause Imports: 19 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

Mainly to fix the current broken go.mod module name

godoc2md converts godoc formatted package documentation into Markdown format.

Usage

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