~humaid/godoc2markdown

e878d1e9fea110273699b8c36a16d87369b241ac — Humaid AlQassimi 4 months ago ceb45a7 master
Add README and fix RegEx for title
2 files changed, 41 insertions(+), 1 deletions(-)

A README.md
M main.go
A README.md => README.md +40 -0
@@ 0,0 1,40 @@
# godoc2markdown
[Visit project page on humaidq.ae](https://humaidq.ae/projects/godoc2markdown/)
## 1. Description

This is a simple Unix-like tool which allows you to pipe the output of `go doc`
to generate Markdown.

The purpose of this tool is to allow private Go projects generate Markdown
documentation, where websites like [GoDoc](https://godoc.org) has no access
to the repository.

## 2. Requirements

The following packages must be installed on your system.

- Go
- Git
- GNU Make

## 3. Copying and contributing

This program is written by Humaid AlQassimi,
and is distributed under the [BSD 2 Clause](https://humaidq.ae/license/bsd-2-clause) license.  

## 4. Download and install

```sh
$ git clone https://git.sr.ht/~humaid/godoc2markdown
$ cd godoc2markdown
$ make install
```

## 5. Example Usage

If you want to generate a Markdown of the package in the current directory,
and save it to a file, you can run.

```sh
$ go doc -all . | godoc2markdown > DOCUMENTATION.md
```

M main.go => main.go +1 -1
@@ 9,7 9,7 @@ import (
)

var (
	titleExp = regexp.MustCompile("^[A-Z]+")
	titleExp = regexp.MustCompile("^[A-Z]+$")
	funcExp  = regexp.MustCompile("^func ")
	descExp  = regexp.MustCompile("^    ")
)