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.
❯ 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
Contributions are always welcome!
This software is provided free under the MIT license.
This project is supported by Numtide.
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 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.