Allows the creation of offline UML diagrams based on the yUML Syntax.
- 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
Please refer to the wiki page
This library is published as a npm package here. For installing use:
npm install yuml-diagram
const yuml_diagram = require('yuml-diagram');
var yuml = new yuml_diagram();
var svgLightBg = yuml.processYumlDocument(yumlText, false);
var svgDarkBg = yuml.processYumlDocument(yumlText, true);
For pull requests, please read CONTRIBUTING.md
- 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