{"id":17968388,"url":"https://github.com/gavv/cobradoc","last_synced_at":"2025-03-25T09:30:49.011Z","repository":{"id":63176612,"uuid":"564727645","full_name":"gavv/cobradoc","owner":"gavv","description":"Alternative documentation generator for Cobra.","archived":false,"fork":false,"pushed_at":"2025-03-05T13:19:49.000Z","size":22,"stargazers_count":13,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-20T00:41:05.037Z","etag":null,"topics":["cobra-cli","documentation","golang","markdown","troff"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gavv.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"liberapay":"gavv","custom":["https://www.paypal.me/victorgaydov"]}},"created_at":"2022-11-11T11:03:28.000Z","updated_at":"2025-03-05T13:19:52.000Z","dependencies_parsed_at":"2023-01-30T09:00:49.249Z","dependency_job_id":null,"html_url":"https://github.com/gavv/cobradoc","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gavv%2Fcobradoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gavv%2Fcobradoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gavv%2Fcobradoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gavv%2Fcobradoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gavv","download_url":"https://codeload.github.com/gavv/cobradoc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245435044,"owners_count":20614817,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cobra-cli","documentation","golang","markdown","troff"],"created_at":"2024-10-29T14:21:12.866Z","updated_at":"2025-03-25T09:30:48.997Z","avatar_url":"https://github.com/gavv.png","language":"Go","funding_links":["https://liberapay.com/gavv","https://www.paypal.me/victorgaydov"],"categories":[],"sub_categories":[],"readme":"# cobradoc [![GoDev](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go\u0026logoColor=white)](https://pkg.go.dev/github.com/gavv/cobradoc) [![Build](https://github.com/gavv/cobradoc/workflows/build/badge.svg)](https://github.com/gavv/cobradoc/actions) [![GitHub release](https://img.shields.io/github/release/gavv/cobradoc.svg)](https://github.com/gavv/cobradoc/releases)\n\nAlternative documentation generator for golang [Cobra](https://github.com/spf13/cobra).\n\nHighlights\n----------\n\n* Supports markdown and manpage (troff) formats\n* Supports command groups\n* Generates single page for the whole command tree\n\nReference\n---------\n\nAPI reference is available on [pkg.go.dev](https://pkg.go.dev/github.com/gavv/cobradoc#section-documentation).\n\nExample\n-------\n\n[_example](_example) directory demonstrates usage of this package.\n\nIt contains:\n\n* [example cobra tool](_example/example.go)\n* [generated manual page](_example/_manpage.md)\n* [generated markdown](_example/_markdown.md)\n\nUsage\n-----\n\nGenerate markdown page:\n\n```go\nimport \"github.com/gavv/cobradoc\"\n\nerr := cobradoc.WriteDocument(os.Stdout, rootCmd, cobradoc.Markdown, cobradoc.Options{\n\tName:             \"my-tool\",\n\tHeader:           \"My page header\",\n\tShortDescription: \"My tool description\",\n})\nif err != nil {\n\tpanic(err)\n}\n```\n\nGenerate manual page:\n\n```go\nimport \"github.com/gavv/cobradoc\"\n\nerr := cobradoc.WriteDocument(os.Stdout, rootCmd, cobradoc.Troff, cobradoc.Options{\n\tName:             \"my-tool\",\n\tHeader:           \"My page header\",\n\tShortDescription: \"My tool description\",\n\tExtraSections: []cobradoc.ExtraSection{\n\t\t{\n   \t\t\tTitle: cobradoc.BUGS,\n\t\t\tText:  \"Please report bugs via GitHub\",\n\t\t},\n\t},\n})\nif err != nil {\n    panic(err)\n}\n```\n\nCredits\n-------\n\nThis package is inspired by [cobraman](https://github.com/rayjohnson/cobraman) by Ray Johnson, but uses single-page approach and adds support for command groups.\n\nAuthors\n-------\n\nSee [here](AUTHORS.md).\n\nLicense\n-------\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgavv%2Fcobradoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgavv%2Fcobradoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgavv%2Fcobradoc/lists"}