Skip to content

Latest commit

 

History

History
37 lines (29 loc) · 1.44 KB

README.md

File metadata and controls

37 lines (29 loc) · 1.44 KB

yUML diagrammer

Allows the creation of offline UML diagrams based on the yUML Syntax.

NPM Status

Features

  • Currently, the following diagram types are supported:
    • Class
    • Activity
    • Use-case
    • State
    • Deployment
    • Package
    • Sequence
  • Additional directives for altering diagram type and orientation
  • Embedded rendering engine: No need to call an external web service

yUML syntax

Please refer to the wiki page

Invocation methods

Code sample here

Issue reporting

If you have experience developing Visual Studio Code extensions, please propose a detailed solution for any reported issue or feature request.

Contributing

For pull requests, please read CONTRIBUTING.md

Credits

  • Syntax and some examples taken from yuml.me
  • This package uses a Javascript port of Dot/Graphviz called viz.js
  • The yuml-to-dot translator is loosely based on a Python project called scruffy
  • The new sequence diagram is based on this github fork