UML diagramming package based on the yUML syntax
Clone or download
jaime-olivares Merge pull request #15 from aduh95/patch-2
Add support for bg customization on class elements. Fixes #14
Latest commit cd5facb Nov 4, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode Added test artifacts Jun 7, 2018
data First commit of source code May 21, 2018
src Add support for bg customization on class elements Oct 28, 2018
test Fixes issue #6 Jun 9, 2018
.gitignore Added test artifacts Jun 7, 2018
.npmignore Added npmignore Jun 7, 2018
CONTRIBUTING.md Update CONTRIBUTING.md May 21, 2018
LICENSE.md First commit May 21, 2018
README.md Update README.md May 28, 2018
index.js First commit of source code May 21, 2018
package.json Fixes issue #6 Jun 9, 2018

README.md

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

Installation

This library is published as a npm package here. For installing use:

npm install yuml-diagram

Usage example

const yuml_diagram = require('yuml-diagram');

var yuml = new yuml_diagram();
var svgLightBg = yuml.processYumlDocument(yumlText, false);
var svgDarkBg = yuml.processYumlDocument(yumlText, true);

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