https://github.com/inancgumus/godocc
go doc with colors
https://github.com/inancgumus/godocc
godoc golang
Last synced: 7 months ago
JSON representation
go doc with colors
- Host: GitHub
- URL: https://github.com/inancgumus/godocc
- Owner: inancgumus
- License: mit
- Created: 2019-01-27T21:52:32.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-05-28T21:25:40.000Z (over 3 years ago)
- Last Synced: 2025-03-19T00:53:43.541Z (7 months ago)
- Topics: godoc, golang
- Language: Go
- Size: 1.06 MB
- Stars: 137
- Watchers: 3
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# godocc
Like `go doc` but with colors.
## Installation
```
$ go install github.com/inancgumus/godocc@latest
```
## Usage
Accepts all the arguments and flags `go doc` works with. Godocc is just a simple wrapper around the go doc tool.
Example:
```
$ godocc io Writer
```
```
$ godocc ioutil
```
## Styling
godocc comes with many colors! Configure the color of the output by setting the following env variable:
```
$ GODOCC_STYLE="dracula"
```
**My favorite styles:** dracula, monokai, fruity, native, paraiso-dark, pygments, rainbow_dash, rrt, solarized-dark, swapoff, vim.
**Other styles:** abap, algol, arduino, autumn, borland, bw, colorful, emacs, friendly, github, igor, lovelace, manni, monokailight, murphy, paraiso-light, pastie, perldoc, solarized-light256, solarized-light, tango, trac, vs, xcode.
_NOTE: Godocc uses the awesome [Chroma](https://github.com/alecthomas/chroma) package underneath._