godoc2md

README

godoc2md

godoc2md converts godoc formatted package documentation into Markdown format. If the current directory is inside a go module, it will use go.mod to find the source to document. Otherwise, it will use $GOPATH

Usage

godoc2md github.com/gideaworx/godoc2md > ./README.md

---

Generated by godoc2md

Documentation

Overview

godoc2md converts godoc formatted package documentation into Markdown format. If the current directory is inside a go module, it will use go.mod to find the source to document. Otherwise, it will use $GOPATH

Usage

godoc2md github.com/gideaworx/godoc2md > ./README.md