{"repo":"chocolacula/gdmd","free":true,"listed":false,"github":"https://github.com/chocolacula/gdmd","clone":"git clone https://github.com/chocolacula/gdmd.git","description":"Alternative to godoc - generates static Markdown documentation instead of running HTTP server.","language":"Go","stars":19,"topics":["godoc","markdown","static"],"license":"Apache-2.0","category":"productivity","readme_excerpt":"Go Doc Markdown godoc alternative for static Markdown documentation. Motivation Standard pkg.go.dev is awesome but not suitable for private repos. You can use pkgsite as local alternative but it's not perfect. Both occasionally skip certain files and generate incomplete documentation. As stated in the comment of an engineer from Amazon sometimes it's a nightmare. You have to checkout a repo, run local server and open it in a browser only to read documentation. With gdmd you don't even have to host your documentation, you can keep it in your repo along with the code. The generator creates a README.md with a package documentation in a package folder. You can navigate through the documentation right in GitHub UI, any open directory with source code will render its documentation. How to use First, you have to Then generate documentation for a package in a directory Example package main The single package in the project, contains data representation, parsing, and generation logic. Index - Variables - Functions - func Generate(root string, pkg Package) error - Types - type Function - func NewFunction(fset token.FileSet, f doc.Func) (Function, error) - type Package - [func NewPackage(fset token.FileSet, p doc.Package, dir string, nested []Package, files []string) (Package, error)](#func-newpackage) - func Parse(root, path string, recursive bool) (Package, error) - type Position - type Type - func NewType(fset token.FileSet, t doc.Type) (Type, error) - type Variable - func NewVariabl","default_branch":null,"files":null,"tree":[],"storefront":"/r/chocolacula","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/chocolacula/gdmd/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}