https://github.com/numtide/godoc
Custom Go doc generation
https://github.com/numtide/godoc
buildbot-numtide go golang
Last synced: 3 months ago
JSON representation
Custom Go doc generation
- Host: GitHub
- URL: https://github.com/numtide/godoc
- Owner: numtide
- License: mit
- Created: 2024-09-10T14:44:58.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-06T11:47:17.000Z (4 months ago)
- Last Synced: 2025-06-22T05:05:56.621Z (4 months ago)
- Topics: buildbot-numtide, go, golang
- Language: Go
- Homepage:
- Size: 23.4 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Godoc
> [!NOTE]
> **Status: alpha**
`godoc` is a custom documentation generator for [Go] projects. Currently focused on [Markdown], it may expand into other areas such as JSON schemas.
> [!WARNING]
Heavily biased towards [Numtide] use cases and projects.
## Quick Start
```console
❯ nix run .# -- --help
Custom Go doc generation
Usage:
godoc [source directory] [flags]
Flags:
-c, --clean clean output directory before writing
-h, --help help for godoc
-o, --out string output directory
```
## Contributing
Contributions are always welcome!
## License
This software is provided free under the [MIT] license.
---
This project is supported by [Numtide](https://numtide.com/).
We’re a team of independent freelancers that love open source.
We help our customers make their project lifecycles more efficient by:
- Providing and supporting useful tools such as this one.
- Building and deploying infrastructure, and offering dedicated DevOps support.
- Building their in-house Nix skills, and integrating Nix with their workflows.
- Developing additional features and tools.
- Carrying out custom research and development.
[Contact us](https://numtide.com/contact) if you have a project in mind,
or if you need help with any of our supported tools, including this one.
We'd love to hear from you.
[MIT]: ./LICENSE
[Numtide]: https://numtide.com
[Markdown]: https://www.markdownguide.org/
[Go]: https://go.dev/