Skip to content

A Notepad++ plugin to generate, view and export PlantUML diagrams

License

Notifications You must be signed in to change notification settings

Fruchtzwerg94/PlantUmlViewer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PlantUML Viewer

License Latest release Downloads Donate

A Notepad++ plugin to generate view and export PlantUML diagrams.

Features

  • Official and full PlantUML syntax
  • Dockable panel to show the generated PlantUML diagrams
  • Zoomable diagrams
  • PNG export of diagrams
  • Dark mode support

Latest changes

You can find latest and all other changes in the changelog.

Installation

Download a release version and copy the folder PantUmlViewer with its content to the plugins subfolder of your Notepad++ installation directory.

Plugin Manager

If you have the Plugin Manager installed you can search for PlantUML Viewer and install it.

Compatibility

This plugin requires at least

  • Notepad++ 32-bit or 64-bit
  • Windows
  • .NET Framework 4.6.1 or above
  • Java

Usage

PlantUML Viewer can be opened

  • by clicking the toolbar icon UML icon
  • via the Plugins submenu

PlantUML Viewer PlantUML Viewer

By clicking the Refresh button the diagram gets generated out of the current opened document. The file extension doesn't matter. The diagram can be moved by dragging and zoomed by scrolling. The currently showed diagram can be exported as PNG image by clicking the Export button.

Make sure JAVA_PATH is set in your system or set the right path to your Java installation in the plugins options.

PlantUML Viewer PlantUML Viewer

You may also want use this plugin in combination with PlantUML_Notepad-_UDL, which enables the PlantUML language syntax for Notepad++.

License and credits

PlantUML Viewer is released under the MIT License.

This Notepad++ plugin integrates the sources of multiple other libraries, because of issues with the library merging process. Credits and thanks to all the developers working on these great projects:

  • The plugin is based on the Notepad++ PluginPack.net by kbilsted provided under the Apache-2.0 license.
  • The plugin uses the PlantUML .Net wrapper PlantUml.Net by KevReed provided under the MIT License.
  • The plugin uses the ImageBox Control by Cyotek provided under the MIT License.
  • The plugin release includes the PlantUML binaries of PlantUML which are free to use and released under the GNU General Public License.

Feedback, issues and contribution

Resonable feedback, issues and contributions are always very welcome. Feel free to bring in your points!

Disclaimer

This source and the whole package comes without warranty. It may or may not harm your computer or cell phone. Please use with care. Any damage cannot be related back to the author. The source has been tested on a virtual environment and scanned for viruses and has passed all tests.

Personal Note

I've created this software in my leasure time since I found no comparable solution to preview PlantUML diagrams seamlessly in Notepad++. This software (with all its bugs) is not aiming to be an enterprise solution. It surely will not fulfill the needs of everybody. But it maybe is a nice little helper for some of you. I am always open for your reasonable feedback, issues and contributions. Feel free to contact me and have fun with it.