Git Product home page Git Product logo

pegmatite's Introduction

Pegmatite - Chrome ext to preview PlantUML in markdown

Pegmatite is Google Chrome extension that replace PlantUML code blocks into preview images.

Chrome web store

Summary

You will see below But we see
Code block UML diagraml
  • This extension is enabled only in the whitelisted sites.
    • https://github.com/*
    • https://gist.github.com/*
    • https://gitpitch.com/*
    • https://gitlab.com/*
    • https://bitbucket.org/*
    • https://*.backlog.jp/wiki/*
  • Replace only code block with lang uml and starts with @start.
    • lang puml or plantuml is also supported.
  • When the element is double-clicked, element will toggle original code block and preview image.

Sample contents

Sequence diagram with lang uml

@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response

Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
@enduml

State diagram with lang puml

@startuml
[*] --> State1
State1 --> [*]
State1 : this is a string
State1 : this is another string

State1 -> State2
State2 --> [*]
@enduml

Other code blocks

These cannot preview.

Code block without lang uml

@startuml
Foo -> Bar
@enduml

uml code block does not starts with @start

foo
bar
baz

Using another PlantUML server

By default, Pegmatite uses PlantUML server deployed to https://www.plantuml.com/plantuml.

However, if your UML is confidential and you cannot send it to an external server, you can also use any PlantUML server. Configuring "Base URL" on the setting page, Pegmatite delegates image generation to this server.

Examples.

  • https://www.plantuml.com/plantuml/img/ (default)
  • https://www.plantuml.com/plantuml/svg/
  • https://any-plantuml-server.example.com:8080/img/

Also you can run PlantUML server in localhost using Docker as following command:

$ docker run -d -p 8080:8080 plantuml/plantuml-server

And you can specify http://localhost:8080/img/ as Base URL.

Note: To avoid mixed-content, if the Base URL is not HTTPS scheme, generated image is converted to DATA URI.

Contribution

  1. Fork (https://github.com/dai0304/pegmatite/fork)
  2. Create a feature branch named like feature/something_awesome_feature from develop branch
  3. Commit your changes
  4. Rebase your local changes against the develop branch
  5. Create new Pull Request

Author

Daisuke Miyamoto

pegmatite's People

Contributors

dai0304 avatar dependabot-preview[bot] avatar dip-tadachi avatar tsujimitsu avatar tykep avatar wreulicke avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

pegmatite's Issues

Cannot render PlantUML diagram when rendering DOM dynamically (like SPA)

Some web apps (especially GitHub) renders web pages dynamically like SPA.
However, this plugin doesn't render a diagram of PlantUML code inserted dynamically.
So, I would recommend this plugin to detect DOM changes by watching DOM periodically (e.g. per 5 sec?) in order to render such a diagram.

Reproduction step

  1. Open https://github.com/dai0304/pegmatite
  2. Click Issues
  3. Click this issue
  4. Confirm the plugin doesn't render the following PlantUML code
    (If you open this issue page directly by entering the URL, then this plugin works well)
@startuml

[*] --> State1
State1 --> [*]
State1 : this is a string
State1 : this is another string

State1 -> State2
State2 --> [*]

@enduml

test

@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response

Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
@enduml

New permissions are being required

Hello, I'm using this awesome plugin. Thank you for your great work.

Yesterday (2020-01-05) the dialog for requiring new permissions was showed up.

Screen Shot 2020-01-06 at 13 27 00

Is it by design? I didn't find a changelog, and I think this plugin needs permission for only visiting site so I'm afraid the new permissions are mistakenly being required.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.