{"id":13511610,"url":"https://github.com/thedevsaddam/docgen","last_synced_at":"2025-05-16T15:06:47.542Z","repository":{"id":39715409,"uuid":"116273934","full_name":"thedevsaddam/docgen","owner":"thedevsaddam","description":"Transform your postman collection to HTML/Markdown documentation","archived":false,"fork":false,"pushed_at":"2023-06-18T05:08:50.000Z","size":2506,"stargazers_count":983,"open_issues_count":26,"forks_count":136,"subscribers_count":15,"default_branch":"v3","last_synced_at":"2025-04-12T11:58:18.400Z","etag":null,"topics":["api-client","api-documentation","api-documentation-tool","postman-collection"],"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/thedevsaddam.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-01-04T15:08:08.000Z","updated_at":"2025-04-07T00:43:35.000Z","dependencies_parsed_at":"2024-06-18T20:12:07.682Z","dependency_job_id":null,"html_url":"https://github.com/thedevsaddam/docgen","commit_stats":{"total_commits":89,"total_committers":8,"mean_commits":11.125,"dds":0.2359550561797753,"last_synced_commit":"67e675d7b791153303566ad3ea18a01d3be22125"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thedevsaddam%2Fdocgen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thedevsaddam%2Fdocgen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thedevsaddam%2Fdocgen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thedevsaddam%2Fdocgen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thedevsaddam","download_url":"https://codeload.github.com/thedevsaddam/docgen/tar.gz/refs/heads/v3","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254553959,"owners_count":22090417,"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":["api-client","api-documentation","api-documentation-tool","postman-collection"],"created_at":"2024-08-01T03:01:00.477Z","updated_at":"2025-05-16T15:06:47.509Z","avatar_url":"https://github.com/thedevsaddam.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"Docgen\n=====================\n\nTransform your postman collection to HTML/Markdown documentation\n\n![Task screenshot](screenshot.png)\n\n#### Installation/Update on Mac/Linux\n```bash\ncurl https://raw.githubusercontent.com/thedevsaddam/docgen/v3/install.sh -o install.sh \\\n\u0026\u0026 sudo chmod +x install.sh \\\n\u0026\u0026 sudo ./install.sh \\\n\u0026\u0026 rm install.sh\n```\n\n#### Uninstallation\n```bash\ncurl https://raw.githubusercontent.com/thedevsaddam/docgen/v3/uninstall.sh -o uninstall.sh \\\n\u0026\u0026 sudo chmod +x uninstall.sh \\\n\u0026\u0026 sudo ./uninstall.sh \\\n\u0026\u0026 rm uninstall.sh\n```\n\n#### Windows\n**For windows download the binary and set environment variable so that you can access the binary from terminal**\n\n#### Binary link\n[Download binary](https://github.com/thedevsaddam/docgen/releases)\n\n### Available features\n* Live postman collection to documentation\n* Build postman collection to html/markdown documentation\n* Supports multi-level collection build\n\n### Usage\n* To view live HTML documentation from postman collection use `docgen server -f input-postman-collection.json -p 8000` This will open the html version of postman collection to the defined port\n* To view live Markown documentation from postman collection use `docgen server -f input-postman-collection.json -p 8000 -m` This will open the markdown version of postman collection to the defined port\n* To make HTML documentation use `docgen build -i input-postman-collection.json -o ~/Downloads/index.html`\n* To make Markdown documentation use `docgen build -i input-postman-collection.json -o ~/Downloads/index.md -m`\n\n***[Demo markdown API documentation](_examples/example-doc.md)***\n\n### Contributor\n1. [Anondo](https://github.com/Anondo)\n\n### Contribution\nYour suggestions will be more than appreciated.\n[Read the contribution guide here](CONTRIBUTING.md)\n\n### See all [contributors](https://github.com/thedevsaddam/docgen/graphs/contributors)\n\n### **License**\nThe **docgen** is an open-source software licensed under the [MIT License](LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthedevsaddam%2Fdocgen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthedevsaddam%2Fdocgen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthedevsaddam%2Fdocgen/lists"}