{"id":19930999,"url":"https://github.com/vitalegi/structurizr-md","last_synced_at":"2025-05-03T10:32:23.536Z","repository":{"id":186581526,"uuid":"675376580","full_name":"vitalegi/structurizr-md","owner":"vitalegi","description":"C4 Model (Structurizr) to Markdown","archived":false,"fork":false,"pushed_at":"2024-10-21T15:44:23.000Z","size":1995,"stargazers_count":5,"open_issues_count":13,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-22T02:59:28.682Z","etag":null,"topics":["c4-model","markdown"],"latest_commit_sha":null,"homepage":"","language":"Java","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/vitalegi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2023-08-06T17:55:59.000Z","updated_at":"2024-10-21T15:44:26.000Z","dependencies_parsed_at":"2023-12-04T17:27:58.172Z","dependency_job_id":"b8af3e95-9f35-46c8-89ea-28deb07ad62a","html_url":"https://github.com/vitalegi/structurizr-md","commit_stats":null,"previous_names":["vitalegi/architecture","vitalegi/c4-model-arch","vitalegi/structurizr-md"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitalegi%2Fstructurizr-md","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitalegi%2Fstructurizr-md/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitalegi%2Fstructurizr-md/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitalegi%2Fstructurizr-md/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vitalegi","download_url":"https://codeload.github.com/vitalegi/structurizr-md/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224360300,"owners_count":17298319,"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":["c4-model","markdown"],"created_at":"2024-11-12T23:05:48.181Z","updated_at":"2024-11-12T23:05:48.715Z","avatar_url":"https://github.com/vitalegi.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# README\n\nAim of the project is to build a tool that simplifies the generation/maintenance of [C4 Model](https://c4model.com/) diagrams.\n\nWith this in mind, [Structurizr](https://structurizr.com/)'s approach of diagrams and models as code is a good tool for the diagram generation.\n\nWhat's found to be missing?\n\n- Easy and fast export of all diagrams\n- Generation of additional documentation in a portable format (markdown, in our case)\n- Auto-generation of containers/components\n\n## Prerequirements\n\n- Java 17\n- Maven\n- (TBV) \u003chttps://graphviz.org/\u003e\n\n```\n$env:PATH=\"C:\\a\\software\\graphviz-8.1.0-win32\\Graphviz\\bin;${env:PATH}\"\n```\n\n## Build\n\n```\nmvn clean package\n```\n\n## Run\n\nThere are several way to run the application.\n\nCompile and run with maven\n\n```\nmvn clean compile exec:java \"-Dexec.args=$arg1 $arg2 ...\" \"-Dexec.mainClass=$mainClass\"\n```\n\nRun from the target folder\n\n```\njava -cp target/structurizr-md-jar-with-dependencies.jar $mainClass $arg1 $arg2 ...\n```\n\nRun the distribution version\n\n```\njava -cp structurizr-md.jar $mainClass $arg1 $arg2 ...\n```\n\n\n### Generate images\n\n```\nmvn clean compile exec:java \"-Dexec.args=sample.dsl sample/md/images/\" \"-Dexec.mainClass=it.vitalegi.structurizr.md.GenerateImagesApp\"\n```\n\nWill read configuration from file `sample.dsl` and export the images in `sample/images` folder.\n\nBoth values can be replaced with absolute/relative paths.\n\n### Generate Markdown pages\n\n```\nmvn clean compile exec:java \"-Dexec.args=sample.dsl sample/md/\" \"-Dexec.mainClass=it.vitalegi.structurizr.md.GenerateMarkdownApp\"\n```\n\n#### Params\n\n| Position | Mandatory | Default value | Description                                                                                    |\n| -------- | --------- | ------------- |------------------------------------------------------------------------------------------------|\n| 1        | Yes       | N/A           | Path to the DSL file                                                                           |\n| 2        | Yes       | N/A           | Folder where to create the generated content                                                   |\n| 3        | No        | true          | true \u0026rarr; generate all default views. false \u0026rarr; use only the views available in the model |\n\n## Contributions\n\nThanks, but no.\n\n## Bugs\n\nKeep them. \n\n## Support\n\nYou are on your own.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitalegi%2Fstructurizr-md","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvitalegi%2Fstructurizr-md","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitalegi%2Fstructurizr-md/lists"}