https://github.com/zeroidentidad/godoclite
little "godoc" emulator that extend "go doc" with "go/doc" pkg usage
https://github.com/zeroidentidad/godoclite
doc-generator go-doc-html
Last synced: 6 months ago
JSON representation
little "godoc" emulator that extend "go doc" with "go/doc" pkg usage
- Host: GitHub
- URL: https://github.com/zeroidentidad/godoclite
- Owner: zeroidentidad
- Created: 2024-06-21T20:13:09.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-06-22T02:11:23.000Z (11 months ago)
- Last Synced: 2024-06-23T05:05:45.357Z (11 months ago)
- Topics: doc-generator, go-doc-html
- Language: Go
- Homepage:
- Size: 3.91 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# godoclite
`little "godoc" emulator that extend "go doc" with "go/doc" pkg usage`
Help to check if documentation to [pkg.go.dev](https://pkg.go.dev) is ok on the fly.
Follow the comments rules at [tip.golang.org/doc/comment](https://tip.golang.org/doc/comment)
## why godoclite?
- "go doc" only show documentation on a single mode at one time
- "godoc" only show documentation found in gopath, is necessary use "go get" to download module with packages every time documentation comments change
- godoclite approach can be a isolated documentation server for projects
- godoclite may help to check if documentation to hold in pkg.go.dev is ok before publish
## installation
```sh
go install github.com/zeroidentidad/godoclite@latest
```
## usage
```sh
# show usage help:
godoclite -h
#output:
Usage of godoclite:
-pkg string
Path to the Go package (default ".")
-port string
Port to serve documentation (default "8080")
```
```sh
# run binary with flags:
godoclite -pkg=./path/to/your/package -port=8080
# run binary without flags on package dir:
godoclite
```
## sample result
