Package goreadme creates readme markdown file from go doc.
This package can be used as a web service, as a command line tool or as a library.
Try the web service.
Integrate directly with Github.
Use as a command line tool:
$ go get github.com/posener/goreadme/...
$ goreadme -hBoth go doc and readme files are important. Go doc to be used by your user's library, and README file to welcome users to use your library. They share common content, which is usually duplicated from the doc to the readme or vice versa once the library is ready. The problem is that keeping documentation updated is important, and hard enough - keeping both updated is twice as hard.
This library provides an easy way to create the one from the other. Using the goreadme Github App makes it even easier.
The formatting of the README.md is done by the go doc parser. This makes the
Result README.md a bit more limited.
Currently, goreadme supports the formatting as explained
in godoc page.
Meaning:
-
A header is a single line that is separated from a paragraph above.
-
Code block is recognized by indentation.
-
Inline code is marked with backticks.
-
URLs will just automatically converted to links.
Additionally, some extra formatting was added.
-
Local paths will be automatically converted to links, for example: ./goreadme.go.
-
A url and can have a title, as follows: goreadme website.
-
A local path and can have a title, as follows: goreadme main file.
-
An image can be added:
- cmd/goreadme: Package main is a command line util that takes a Go repository and write to stdout the calculated README.md content.
Created by goreadme