Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Support PlantUML within Markdown #65

Closed
paulvi opened this issue Jun 9, 2018 · 5 comments
Closed

Support PlantUML within Markdown #65

paulvi opened this issue Jun 9, 2018 · 5 comments
Milestone

Comments

@paulvi
Copy link

paulvi commented Jun 9, 2018

There are several places where PlantUML within markdown is already supported

e.g. https://docs.gitlab.com/ee/administration/integration/plantuml.html

Code Example

```puml
	Mardown -> PlnatUML : hello
```

Please support within this plugin

Currently it does not

image

@paulvi
Copy link
Author

paulvi commented Jun 9, 2018

Currently requires @startuml and @enduml

image

@hallvard
Copy link
Owner

OK, so the proposal is to support a wider set of prefix and suffix pairs.

@paulvi
Copy link
Author

paulvi commented Jun 11, 2018

Yes, prefix ```puml
is already used on https://docs.gitlab.com/ee/administration/integration/plantuml.html

But the rest of ```puml line may have some additional parameters,
so actual PlantUML will start on next line.

Within ```puml block can be other type of diagram, not UML,
e.g. @startsalt and `@endsalt` pair,
or `@startdot` and `@enddot` pair,
so `@startuml` and `@enduml` pair becomes default.

For example a file with extension .puml and single line

Bob->Alice : hello

is also valid PlantUML document/diagram, isn't it?

@hallvard
Copy link
Owner

It's easier to support special prefixes/suffixes when they're tied to a specific editor or file extension, like md or puml. So if it's OK with you, I'd rather add this as md- and puml-specific rules.

@paulvi
Copy link
Author

paulvi commented Sep 26, 2018

As you prefer

@hallvard hallvard added this to the 1.1.24 milestone Apr 7, 2019
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants