Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sathukorale/graph-generator
A simple node server that can convert a selected set of diagram'ing code such as dot or PlantUML to their respective image file.
https://github.com/sathukorale/graph-generator
actdiag blockdiag blockdiagram diagram ditaa graphviz graphviz-dot mermaid nwdiag packetdiag plantuml plantuml-diagrams rackdiag seqdiag uml uml-diagram
Last synced: about 1 month ago
JSON representation
A simple node server that can convert a selected set of diagram'ing code such as dot or PlantUML to their respective image file.
- Host: GitHub
- URL: https://github.com/sathukorale/graph-generator
- Owner: sathukorale
- Created: 2019-09-20T12:20:58.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2019-10-01T10:51:34.000Z (about 5 years ago)
- Last Synced: 2024-08-02T12:50:00.386Z (4 months ago)
- Topics: actdiag, blockdiag, blockdiagram, diagram, ditaa, graphviz, graphviz-dot, mermaid, nwdiag, packetdiag, plantuml, plantuml-diagrams, rackdiag, seqdiag, uml, uml-diagram
- Language: Shell
- Homepage:
- Size: 82 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-starred - sathukorale/graph-generator - A simple node server that can convert a selected set of diagram'ing code such as dot or PlantUML to their respective image file. (others)
README
# Graph Generator Server
In my experience adding a diagram into markdown has never been that convenient. Either you have to upload images then reference them (and redo this everytime something changes), or depend on external services through other inconvenient means. This project aims to fix just that.
## Supported Languages
- [X] plantuml
- [X] dot/graphviz
- [X] mermaid
- [X] ditaa
- [X] actdiag
- [X] nwdiag
- [X] blockdiag
- [X] seqdiag
- [X] packetdiag
- [X] rackdiag
- [ ] erd
- [ ] msc
- [ ] shaape
- [ ] syntrax
- [ ] umlet
- [ ] vega
- [ ] vegalite
- [ ] wavedrom
## Running the server
1. Before anything check the following _**list of prerequisites**_. These tools have to be installed and updated to the latest for the installation step to succeed. The server is designed to be quite independant, so a lot of the binaries required by the server, and their dependencies will be downloaded and/or compiled during the initial setup.
* A Linux host
* Java (`java`)
* Wget (`wget`)
* Python2.X (`python`)
* NodeJs (`node`)
* `gcc` and `g++`
* `make`
2. Clone this repository.
3. Move to the root directory (of the repository) and run the `setup.sh` file.
4. If everything goes well, you should be able to start the server with the `start.sh` file.
## Using the Server
Now for the diagrams to show up, the server has to see your diagram contents, and the generated diagram should somehow appear on your screen. So we have developed a couple of ways of making this happen. But if we are missing something [feel free to file an issue](https://github.com/sathukorale/graph-generator/issues/new).
### 1. Through Supported Extensions.
> Before anything, shortcomings : Anyone who views your file have to have these externals tools installed. Otherwise its pretty non-intrusive. Honestly I prefer this method over the others.
```plantuml
@startuml
!include
!include
!include
!include
!include
package "Frontend" {
OFF_DOCUMENT(diagramContent, "Diagram Content")
OFF_3RD_PARTY_SERVICE(extension, "Graph Generator Extension")
file diagramImage [ Diagram Image
<&pie-chart>
]
}
package "Graph Generator Backend" {
OFF_APPLICATION_SERVER(backend, "Graph Generator")
}
diagramContent -r-> extension
diagramImage <-r- extension
diagramContent -[hidden]-> diagramImage
extension -> backend
backend -> extension
@enduml
```
> If you have one of our extensions installed you should see the diagram above, rendered.
### 2. By Embedding Diagram Image Urls.
> Before anything, shortcomings : These diagram files should be visible to the `graph-generator` server. And this method works only if you can embed images into your documentations. Thus this won't render standalone diagrams.
