nomnoml

The sassy UML diagram renderer

Github星跟踪图

nomnoml npm version Known Vulnerabilities

Hello, this is nomnoml, a tool for drawing UML diagrams based on a simple syntax. It tries to keep its syntax visually as close as possible to the generated UML diagram without resorting to ASCII drawings.

Created by Daniel Kallin and a cadre of contributors.

Nomnoml was made possible by these cool projects

Library

The nomnoml standalone javascript library can be used to render diagrams on your own web page. The only dependency is dagre. Install it using either npm or good old script inclusion.

NodeJS usage with SVG output:

    > npm install nomnoml
    var nomnoml = require('nomnoml');
    var src = '[nomnoml] is -> [awesome]';
    console.log(nomnoml.renderSvg(src));

Html usage with a Canvas rendering target:

<script src="dagre.js"></script>
<script src="nomnoml.js"></script>

<canvas id="target-canvas"></canvas>
<script>
    var canvas = document.getElementById('target-canvas');
    var source = '[nomnoml] is -> [awesome]';
    nomnoml.draw(canvas, source);
</script>

SVG support

SVG rendering mode is available as the nomnoml.renderSvg function.

Command Line Interface

dist/nomnoml-cli.js exposes the SVG renderer with a command line interface. This mode also supports the #import: <filename> directive which allow you to separate complex diagrams into multiple files.

Web application

The nomnoml web application is a simple editor with a live preview. It is purely client side and changes are saved to the browser's localStorage, so your diagram should be here the next time, (but no guarantees).

Interaction

The canvas can be panned and zoomed by dragging and scrolling in the right hand third of the canvas. Downloaded image files will be given the filename in the #title directive.

Example

This is how the Decorator pattern looks like in nomnoml syntax:

[<frame>Decorator pattern, [<abstract>Component, + operation()]
  [Client] depends --> [Component]
  [Decorator, - next: Component]
  [Decorator] decorates -- [ConcreteComponent]
  [Component] <:- [Decorator]
  [Component] <:- [ConcreteComponent]
]

Association types

-    association
->   association
<->  association
-->  dependency
<--> dependency
-:>  generalization
<:-  generalization
--:> implementation
<:-- implementation
+-   composition
+->  composition
o-   aggregation
o->  aggregation
--   note
-/-  hidden

Classifier types

[name]
[<abstract> name]
[<instance> name]
[<reference> name]
[<note> name]
[<package> name]
[<frame> name]
[<database> name]
[<start> name]
[<end> name]
[<state> name]
[<choice> name]
[<input> name]
[<sender> name]
[<receiver> name]
[<transceiver> name]
[<actor> name]
[<usecase> name]
[<label> name]
[<hidden> name]

Directives

#arrowSize: 1
#bendSize: 0.3
#direction: down, right
#gutter: 5
#edgeMargin: 0
#edges: hard, rounded
#fill: #eee8d5; #fdf6e3
#fillArrows: false
#font: Calibri
#fontSize: 12
#leading: 1.25
#lineWidth: 3
#padding: 8
#spacing: 40
#stroke: #33322E
#title: filename
#zoom: 1
#acyclicer: greedy
#ranker: network-simplex, tight-tree, longest-path

Directives only available when using the command line interface

#import: my-common-styles.nomnoml

Custom classifier styles

A directive that starts with "." define a classifier style. The style is written as a space separated list of modifiers and key/value pairs.

#.box: fill=#8f8 dashed
#.blob: visual=ellipse
[<box> GreenBox]
[<blob> HideousBlob]

Available key/value pairs are

fill=(any css color)

stroke=(any css color)

align=center
align=left

direction=right
direction=down

visual=actor
visual=class
visual=database
visual=ellipse
visual=end
visual=frame
visual=hidden
visual=input
visual=none
visual=note
visual=package
visual=receiver
visual=rhomb
visual=roundrect
visual=sender
visual=start
visual=transceiver

Available modifiers are

bold
underline
italic
dashed
empty

Contributing

If you want to contribute to the project more info is available in CONTRIBUTING.md.

主要指标

概览
名称与所有者skanaar/nomnoml
主编程语言TypeScript
编程语言HTML (语言数: 4)
平台
许可证MIT License
所有者活动
创建于2014-06-03 07:57:09
推送于2025-03-31 08:28:35
最后一次提交2025-03-31 10:28:17
发布数28
最新版本名称v1.7.0 (发布于 )
第一版名称v0.1.0 (发布于 )
用户参与
星数2.8k
关注者数40
派生数211
提交数402
已启用问题?
问题数175
打开的问题数13
拉请求数30
打开的拉请求数2
关闭的拉请求数12
项目设置
已启用Wiki?
已存档?
是复刻?
已锁定?
是镜像?
是私有?