godoc2md

command module
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 20, 2023 License: BSD-3-Clause Imports: 21 Imported by: 0

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL