https://github.com/vidhill/godoc-examples
https://github.com/vidhill/godoc-examples
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/vidhill/godoc-examples
- Owner: vidhill
- License: mit
- Created: 2022-12-05T22:30:56.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-06T11:49:35.000Z (over 2 years ago)
- Last Synced: 2025-01-17T14:17:24.170Z (5 months ago)
- Language: Go
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# godoc-examples
Dummy project with testable examples that get embedded into docs when using `godoc`
### Links
- Official go blog article: https://go.dev/blog/examples
- Go docs: https://pkg.go.dev/testing#hdr-Examples
- `godoc` package https://pkg.go.dev/golang.org/x/tools/cmd/godoc
- https://pkg.go.dev/github.com/vidhill/godoc-examples
- https://pkg.go.dev/github.com/vidhill/[email protected]
### Install `godoc`
```bash
$ go install golang.org/x/tools/cmd/godoc@latest
```
### Run
```bash
$ godoc -http=:6060
```
### Run tests
```bash
$ go test ./...
```