{"id":27398001,"url":"https://github.com/gni/dockumentor","last_synced_at":"2025-09-07T08:39:31.094Z","repository":{"id":249714779,"uuid":"796331608","full_name":"gni/dockumentor","owner":"gni","description":"docker compose doc generator","archived":false,"fork":false,"pushed_at":"2024-12-10T18:07:52.000Z","size":12,"stargazers_count":18,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-14T01:31:51.684Z","etag":null,"topics":["docker","docker-compose","documentation","generator","mermaid","mermaidjs"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gni.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null}},"created_at":"2024-05-05T16:22:33.000Z","updated_at":"2025-03-10T20:37:03.000Z","dependencies_parsed_at":"2025-04-14T01:31:11.128Z","dependency_job_id":"9512686a-7728-49ee-addf-0c1747c0b42e","html_url":"https://github.com/gni/dockumentor","commit_stats":null,"previous_names":["exaluc/dockumentor","ioluc/dockumentor","gni/dockumentor"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/gni/dockumentor","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gni%2Fdockumentor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gni%2Fdockumentor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gni%2Fdockumentor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gni%2Fdockumentor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gni","download_url":"https://codeload.github.com/gni/dockumentor/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gni%2Fdockumentor/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274014090,"owners_count":25207615,"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","status":"online","status_checked_at":"2025-09-07T02:00:09.463Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["docker","docker-compose","documentation","generator","mermaid","mermaidjs"],"created_at":"2025-04-14T01:26:17.396Z","updated_at":"2025-09-07T08:39:31.057Z","avatar_url":"https://github.com/gni.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"### Dockumentor: Docker Compose Documentation Generator\n\n**Dockumentor** is a tool designed to automatically generate comprehensive documentation for Docker Compose configurations.\n\n#### Features:\n- **Mermaid Diagram Generation:** Automatically generate Mermaid diagrams that visually map the service relationships and network configurations.\n- **Sankey Diagrams for Network and Dependency Insights:** Visualize network ports and service dependencies through Sankey diagrams to better understand internal and external bindings and service interactions.\n- **Template-based Documentation:** Customize documentation output using Jinja2 templates, allowing for flexibility in how information is presented.\n- **CLI Support:** Comes with a command-line interface to easily generate and update documentation directly from the terminal.\n- **Configurable:** Easily adaptable to include more detailed information such as volume mappings, environment variables, and custom commands through a simple YAML configuration.\n\n#### Ideal for:\n- Developers looking to automate the documentation of their Docker environments.\n- Teams requiring consistent and updated documentation for development, testing, and production setups.\n- Educators and trainers who provide tutorials or workshops on Docker and need clear, visual representations of complex configurations.\n\nBy simplifying the documentation process, **Dockumentor** helps you focus more on development and less on the manual effort of maintaining up-to-date documentation of your Docker setups.\n\n## Installation\n\nTo install Dockumentor, you can use pip, the Python package manager. Make sure you have Python and pip installed on your system. Then run the following command:\n\n```bash\npip install dockumentor\n```\n\n## Usage\n\nOnce installed, you can use the Dockumentor CLI to generate a README for your project with Docker Compose.\n\n### Generating Documentation\n\nTo generate a README for a project with a Docker Compose configuration, navigate to your project directory and run the following command:\n\n```bash\ndockumentor --compose-file path/to/docker-compose.yml --output README.md\n```\n\n- `--compose-file`: Specify the path to your `docker-compose.yml` file.\n- `--output`: Specify the path to the output file (e.g., `README.md`). This is where the generated documentation will be written.\n\n### Example Command\n\n```bash\ndockumentor --compose-file ./docker-compose.yml --output ./README.md\n```\n\n### Appending to Existing Documentation\n\nIf you want to append the generated documentation to an existing README file, use the `--append` option:\n\n```bash\ndockumentor --compose-file ./docker-compose.yml --output ./README.md --append\n```\n\nThis will insert the generated documentation within specific markers in the existing README file, ensuring that the new content is added without overwriting the existing content.\n\n### Customizing the Template\n\nDockumentor uses Jinja2 templates to format the generated documentation. You can customize the template to match your project's documentation style. Create a custom template file and specify its path using the `--template` option.\n\n#### Example Command with Custom Template\n\n```bash\ndockumentor --compose-file ./docker-compose.yml --template ./templates/dockumentor_compose.md --output ./README.md\n```\n\nThis command specifies a custom template for generating the documentation. If you don't specify a template, Dockumentor will use a default template.\n\n## Author\n\n- [Lucian BLETAN](https://github.com/gni)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgni%2Fdockumentor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgni%2Fdockumentor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgni%2Fdockumentor/lists"}