Skip to content

Commit

Permalink
updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ankurs committed Mar 15, 2021
1 parent 59a767a commit 613591f
Show file tree
Hide file tree
Showing 11 changed files with 672 additions and 349 deletions.
4 changes: 4 additions & 0 deletions .gomarkdoc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
output: "{{.Dir}}/README.md"
header: |+
[![GoDoc](https://img.shields.io/badge/pkg.go.dev-doc-blue)](http://pkg.go.dev/github.com/go-coldbrew/log)
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
.PHONY: build doc
HEADER="[![GoDoc](https://img.shields.io/badge/pkg.go.dev-doc-blue)](http://pkg.go.dev/github.com/go-coldbrew/log)"
build:
go build ./...

doc:
go get github.com/princjef/gomarkdoc/cmd/gomarkdoc
gomarkdoc ./... > README.md
gomarkdoc ./...
Loading

0 comments on commit 613591f

Please sign in to comment.