Skip to content

gideaworx/godoc2md

 
 

Repository files navigation

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

About

Simple translation from godoc to markdown.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 98.8%
  • Makefile 1.2%