search

nus / gitbucket-plantuml-plugin

A GitBucket plugin that renders PlantUML diagrams.
Apache License 2.0
30 stars 8 forks source link

further PlantUML integration #1

Open McFoggy opened 7 years ago

McFoggy commented 7 years ago

It would be good to start thinking how to integrate into gitbucket rendering mechanism so that inline PlantUML code or references to PlantUML files could be rendered as an image.

What I am thinking of:

  1. Render PlantUML code in Markdown (README, wikis, ...)

For example embedding the following in markdown 

    ```plantuml
    Bob->Alice : hello Alice, I'am Bob
    Alice-->Bob : hello Bob


2. Render references to PlantUML files

this is already possible in mardown using images links and the proxy available on PlantUML site (see [here](https://github.com/plantuml/plantuml-server/issues/4)).
The drawback of that is that it requires access to the internet which is not the case in all the deployments of gitbucket.  
Perhaps a similar feature could be implemented to act the same.
McFoggy commented 7 years ago

I think this could be easily tackled once gitbucket/gitbucket#1307 & more precisely gitbucket/gitbucket#1323 will be done.

nus commented 7 years ago
  1. Render PlantUML code in Markdown (README, wikis, ...)

Sounds good.

nus commented 7 years ago
  1. Render references to PlantUML files

@McFoggy

Now, it is possible to download a PlantUML image from gitbucket on 7cd3b415c3fdbeae79aff702310819d73ac675f7 .