Weclome to Godocgen
Godocgen is an app built using Go programming language to generate Go module package's documentations. It parses the packages documentation data and facilitates custom rendering, enabling Gopher to use other hosting solution like Hugo to host the documents.
Free From Limitations
The initial Go doc webserver imposes a lot of limitations such as:
- not able to create non-Go related documentation alongside its go-doc.
- not able to use images.
- only terminal interface is available for Go Module.
Godocgen aims to free gophers from these limitations once and for all.
- CORE TOOLS
- CORE TOOLS
Godocgen uses standard Go tools like vanilla Go Programming Language for writing its app and Hugo for hosting its documentations website like this page!
On top of that, it is supported by Gitlab.com alongside its CI Runner. This allows us to keep Godocgen always aligned to its own development tools for automated testing instead of depending on many third-party integrations.
Open Source License
- APACHE 2.0
To preserve Godocgen's freedom of use (and modify), Godocgen is licensed under Open-Source Initiative (OSI) compatible Apache 2.0 open-source license.
This also means you are FREE to use Godocgen in terms of:
- Freedom to use.
- Free, as in free beer.
Godogen has the following features:
- ✅Support terminal printout. (
text/templatedocumentations rendering. (
- ✅Support Hugo markdown generation. (
- ✅Support directory index structure. (
Go Getinstallation. (
- 📅Support DEB Server for Debian based Linux rolling release.
- 📅Support RPM Server for RPM based Linux rolling release.
- ✅Unit-tested. (
- ✅Support Examples rendering. (
|📅||Confirmed Proposal. Currently Developing…|
|💡||Considered Ideas. Still Discussing…|
For more information, please check out the Issues board at:
To make sure the project is always free, this project is sponsored by:
You can learn the current developement status of the Git development repository here. Godocgen uses tri-branches for its development where:
masterbranch - stable product releases.
stagingbranch - next stable product releases under testing.
nextbranch - bleeding edge and documentations.
|Branch||Test Status||Test Coverage|
Where to start?
Feel free to explore the documentation site here! In case you need a direction, please start here:
Getting Started Step 1
If you're looking for source code, please do check it out at: