README
¶
main
Overview
main allows you to build go2md binary
go2md
Create markdown documentation from golang code.
This project was inspired by github.com/davecheney/godoc2md, but why I wanted to build it without dependency to golang.org/x/tools v0.0.0-20181011021141-0e57ebad1d6b
Main target audience is private golang projects or anyone, who wants to keep documentation in git repo as files.
Build binary
go build go2md.go will produce you go2md binary.
Imports: 4
Index
Examples
This section is empty.
Constants
This section is empty.
Variables
var Version string // value from version.txt file
--
Generated by github.com/jylitalo/go2md v0.4.1
Documentation
¶
Overview ¶
main allows you to build go2md binary # go2md
[](https://github.com/jylitalo/go2md/actions?query=workflow%3ATest) [](https://pkg.golang.ir/github.com/jylitalo/go2md) [](https://goreportcard.com/report/github.com/jylitalo/go2md)
Create markdown documentation from golang code.
This project was inspired by github.com/davecheney/godoc2md(https://github.com/davecheney/godoc2md), but why I wanted to build it without dependency to golang.org/x/tools v0.0.0-20181011021141-0e57ebad1d6b
Main target audience is private golang projects or anyone, who wants to keep documentation in git repo as files.
## Build binary
`go build go2md.go` will produce you go2md binary.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd provides command line arguments and flags parsing with spf13/cobra and calls backend functionality from pkg package.
|
Package cmd provides command line arguments and flags parsing with spf13/cobra and calls backend functionality from pkg package. |
|
Package pkg provides the backend functionality for golang to markdown transformation.
|
Package pkg provides the backend functionality for golang to markdown transformation. |