godoc2md

command module

v0.0.0-...-289bf01 Latest Latest Go to latest Published: Jan 6, 2022 License: BSD-3-Clause Imports: 18 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

This is a fork of github.com/davecheney/godoc2md, with two small differences:

The x/tools dependency is vendorized as it is unlikely to change.
The boolean flag --writefile has been added, which directs output to a README.md file in the targeted package directory.

go install github.com/rhallora-heidelberg/godoc2md

Call godoc2md --usage for details, but for example you could generate a README for github.com/gorilla/sessions in one of two ways:

godoc2md github.com/gorilla/sessions > examples/sessions/README.md

godoc2md --writefile github.com/gorilla/sessions

godoc2md converts godoc formatted package documentation into Markdown format.

Usage

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