Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vitalegi/structurizr-md
C4 Model (Structurizr) to Markdown
https://github.com/vitalegi/structurizr-md
c4-model markdown
Last synced: 1 day ago
JSON representation
C4 Model (Structurizr) to Markdown
- Host: GitHub
- URL: https://github.com/vitalegi/structurizr-md
- Owner: vitalegi
- License: mit
- Created: 2023-08-06T17:55:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-21T15:44:23.000Z (24 days ago)
- Last Synced: 2024-10-22T02:59:28.682Z (23 days ago)
- Topics: c4-model, markdown
- Language: Java
- Homepage:
- Size: 1.9 MB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# README
Aim of the project is to build a tool that simplifies the generation/maintenance of [C4 Model](https://c4model.com/) diagrams.
With this in mind, [Structurizr](https://structurizr.com/)'s approach of diagrams and models as code is a good tool for the diagram generation.
What's found to be missing?
- Easy and fast export of all diagrams
- Generation of additional documentation in a portable format (markdown, in our case)
- Auto-generation of containers/components
## Prerequirements
- Java 17
- Maven
- (TBV)
```
$env:PATH="C:\a\software\graphviz-8.1.0-win32\Graphviz\bin;${env:PATH}"
```
## Build
```
mvn clean package
```
## Run
There are several way to run the application.
Compile and run with maven
```
mvn clean compile exec:java "-Dexec.args=$arg1 $arg2 ..." "-Dexec.mainClass=$mainClass"
```
Run from the target folder
```
java -cp target/structurizr-md-jar-with-dependencies.jar $mainClass $arg1 $arg2 ...
```
Run the distribution version
```
java -cp structurizr-md.jar $mainClass $arg1 $arg2 ...
```
### Generate images
```
mvn clean compile exec:java "-Dexec.args=sample.dsl sample/md/images/" "-Dexec.mainClass=it.vitalegi.structurizr.md.GenerateImagesApp"
```
Will read configuration from file `sample.dsl` and export the images in `sample/images` folder.
Both values can be replaced with absolute/relative paths.
### Generate Markdown pages
```
mvn clean compile exec:java "-Dexec.args=sample.dsl sample/md/" "-Dexec.mainClass=it.vitalegi.structurizr.md.GenerateMarkdownApp"
```
#### Params
| Position | Mandatory | Default value | Description |
| -------- | --------- | ------------- |------------------------------------------------------------------------------------------------|
| 1 | Yes | N/A | Path to the DSL file |
| 2 | Yes | N/A | Folder where to create the generated content |
| 3 | No | true | true → generate all default views. false → use only the views available in the model |
## Contributions
Thanks, but no.
## Bugs
Keep them.
## Support
You are on your own.