Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Add sequence & workflow diagram support to Markdown #9982

Closed
cilerler opened this issue Jul 30, 2016 · 6 comments
Closed

Add sequence & workflow diagram support to Markdown #9982

cilerler opened this issue Jul 30, 2016 · 6 comments
Assignees
Labels
*extension-candidate Issue identified as good extension implementation feature-request Request for new features or functionality markdown Markdown support issues
Milestone

Comments

@cilerler
Copy link

Supporting syntax through jsSequence and jsFlow would be great.

related #2273

```sequence
Andrew->China: Says Hello
Note right of China: China thinks\nabout it
China-->Andrew: How are you?
Andrew->>China: I am good thanks!
``

sequence

```flow
st=>start: Start:>http://www.google.com[blank]
e=>end:>http://www.google.com
op1=>operation: My Operation
sub1=>subroutine: My Subroutine
cond=>condition: Yes
or No?:>http://www.google.com
io=>inputoutput: catch something...

st->op1->cond
cond(yes)->io->e
cond(no)->sub1(right)->op1
``

flow

@kieferrm kieferrm added feature-request Request for new features or functionality markdown Markdown support issues labels Aug 2, 2016
@kieferrm kieferrm self-assigned this Aug 2, 2016
@chemaoxian
Copy link

yes , it's just what i want

@mjbvz mjbvz added the *extension-candidate Issue identified as good extension implementation label Dec 1, 2016
@kaipaysen
Copy link

I'd love that feature!

@kieferrm kieferrm assigned mjbvz and unassigned kieferrm Feb 22, 2017
@mjbvz mjbvz modified the milestone: Backlog Feb 23, 2017
@mjbvz
Copy link
Collaborator

mjbvz commented Apr 5, 2017

Please take a look at our experimental markdown extension exploration in VSCode 1.11: #22916

For example, here's an experimental extension that adds mermaid diagram support to markdown files using this API: https://github.com/mjbvz/vscode-markdown-mermaid

If someone is interested in prototyping an extension for jsflow or jssequence, I'd be happy to help out and hear any feedback you have on the API. The mermaid extension is probably a good staring point

@seanpk
Copy link

seanpk commented Jul 17, 2017

I am quite interested in having any diagram support in my markdown (I'm not particular about the syntax or underlying technology).
At a basic level, I'd like to be able to replicate what stackedit.io can do for sequence diagrams and flow charts.

@mjbvz - is markdown-mermaid still based on experimental features as indicated in its readme?
What are the next steps for getting a stable extension in place?

Also, related but not necessarily connected to the extension, I wonder what the best practices for doing builds of such documents would look like.

@mjbvz
Copy link
Collaborator

mjbvz commented Jul 17, 2017

@seanpk The markdown extensions API is now enabled by default in the current VS Code insiders builds. I've update the VSCode markdown mermaid extensions to support this. I plan on releasing the extension on the VS Code marketplace after 1.15 ships

Closing this issue since extensions should now be able to contribute this functionality

@mjbvz mjbvz closed this as completed Jul 17, 2017
@seanpk
Copy link

seanpk commented Jul 18, 2017

thanks @mjbvz, that sounds great

@vscodebot vscodebot bot locked and limited conversation to collaborators Nov 17, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
*extension-candidate Issue identified as good extension implementation feature-request Request for new features or functionality markdown Markdown support issues
Projects
None yet
Development

No branches or pull requests

6 participants