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

CLI map generation from markup? #71

Open
jaxley opened this issue May 29, 2020 · 7 comments
Open

CLI map generation from markup? #71

jaxley opened this issue May 29, 2020 · 7 comments
Labels
future consideration Strategic / needs additional thought.

Comments

@jaxley
Copy link

jaxley commented May 29, 2020

The web tool is quite nice for authoring, and the human-readable markup is great to easily create them and modify without even a mouse.

But, I'd like to be able to manage these maps in a git repo, for example, to track changes over time. And perhaps would want to generate SVG or images from the markup. Perhaps even use this in an IDE/editor preview plugin (think PlantUML).

Is there already a CLI version of the tool that could work in this environment?

@ChristianDavis
Copy link
Contributor

There isn't anything in this codebase to do that, but what the whole tool does is generate a map from the markup. So your use case doesn't sound far fetched. Essentially just opening a source file directly then outputting a .png or .svg?

@jaxley
Copy link
Author

jaxley commented May 31, 2020 via email

@damonsk
Copy link
Owner

damonsk commented Oct 30, 2020

OnlineWardleyMaps has been wrapped into a vscode extension which I think will give most of what you need. vscode-wardley-maps

@rdmueller
Copy link

the extension is already quite helpful. If we could really generate svg or png files on the cli, we could also use the diagrams in generated documents like markup, asciidoc or pdf.

@jaxley
Copy link
Author

jaxley commented Sep 22, 2021

Is there any possibility of being able to export the displayed map to PNG from VSCode? Right now, I have to go to https://onlinewardleymaps.com and paste in my markup from VSCode, then use the web PNG export...Kind of a drag.

@damonsk
Copy link
Owner

damonsk commented Dec 28, 2023

Will address this on the vscode-wardleymaps issue/repo.

Is there any possibility of being able to export the displayed map to PNG from VSCode? Right now, I have to go to https://onlinewardleymaps.com and paste in my markup from VSCode, then use the web PNG export...Kind of a drag.

Will revist the PR from @ChristianDavis https://github.com/damonsk/onlinewardleymaps/pull/75/commits

@roylines
Copy link

First: thanks for building such an awesome tool.

+1 on the need for a CLI. It would be SO helpful to be able to use a CLI to take a .wm file and generate a png/svg. This could be used as part of a build pipeline to create docs (so no vscode available). Makes the whole thing scale outside of a single user. The vscode plugin is very helpful whilst editing - but a cli could then be used in for example a github action to generate and publish a diagram into a document repository.

I've tried to figure how to build this myself, but with the engine being in frontend code, I can't think of a nice way to make it headless

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
future consideration Strategic / needs additional thought.
Projects
None yet
Development

No branches or pull requests

5 participants