You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This commit was created on GitHub.com and signed with GitHub’s verified signature.
Added
Graphviz DOT: graph, digraph, and strict sources, .dot and .gv files in
directories, and dot or graphviz Markdown blocks draw with sirene's layout, including
clusters, node and edge defaults, record labels as compartments, shapes, colors, arrows,
and end labels. Attributes that are not drawn are warnings.
DOT rank=same subgraphs, constraint=false, and minlen=0: nodes share a rank, and edges
between them run straight across, below the rank, or up through a label above it.
DOT rank=min, max, source, and sink subgraphs: nodes go in the first or last rank,
or a rank of their own above or below every other node.
DOT compound=true with lhead and ltail: edges end at a cluster's border.
DOT ordering=out and ordering=in on the graph or a node keep its edges in source order.
DOT node group: edges between nodes of one group run straight.
DOT compass ports (a:e, a:p:sw, tailport, headport) move an edge end toward that end
of the node side.
DOT record ports (a:p, <p> fields) join the field's line in rankdir=LR and RL graphs.
DOT HTML table node labels draw as compartments, with <HR/> sections and PORT cells.
--lang mermaid|dot|plantuml reads every diagram as that language. Without it, a file's
extension (.dot, .gv, .mmd, .mermaid, .puml, .plantuml, .pu, .iuml) or a
Markdown block's name picks the language in the CLI and the editor, and other sources are
detected from their first line.
PlantUML sequence diagrams (@startuml), drawn by the sequence layout and read-only in the
editor: participant kinds, aliases, order, boxes, arrows with crosses, edges ([->, ->]), ++/--/**/!!, return, autonumber, notes, frames, group, separators (== x ==),
delays (...), spaces (|||), ref over, and hide footbox. Constructs that are not drawn
are warnings, and other PlantUML diagram kinds are errors.
PlantUML activity diagrams, drawn by the layered layout: actions and their shapes, start, stop, end, if/elseif/else, switch, while, repeat with backward, break, fork, split, partitions and groups, swimlanes (|Lane|), arrow labels and styles, and
notes. The diagram kind is detected from the first statement as PlantUML does.
PlantUML class and object diagrams, drawn with compartments: class kinds and stereotypes,
members with {static}/{abstract} and separators, extends/implements, links with every
head, multiplicities, direction words, and -[#color,dashed]-> styles, packages, objects,
maps, hide empty members, and notes.
PlantUML state diagrams: start and end states, descriptions below the name, colors, <<choice>>, <<fork>>, <<join>>, history states, composite states with concurrent
regions (--, ||), styled transitions, and notes.
PlantUML use case, component, and deployment diagrams: actors, use cases, components,
interfaces, and the deployment element shapes (node, database, cloud, queue, artifact, ...), the :x:, (x), [x], and () x short forms, stereotypes, colors,
descriptions, nested containers, styled links, notes, and skinparam actorStyle.
PlantUML mindmaps (@startmindmap) and work breakdown structures (@startwbs): *, +,
and - node lines or indented * lines, boxless nodes, multi-line :text;, WBS colors,
aliases, and (A) -> (B) arrows.
PlantUML Gantt charts (@startgantt): tasks with durations, start and end dates, then,
references to other tasks' starts and ends, [A] -> [B], milestones, completion, sections,
closed weekdays and dates, printscale, and today is.
PlantUML JSON and YAML (@startjson, @startyaml), drawn left to right as a table per object
or array with lines to nested tables.
Compartment nodes with an empty label have no title area.
PlantUML @startdot (a Graphviz graph), @startebnf (drawn as a railroad diagram), and @startfiles (paths drawn as a tree view, with <note> descriptions).
PlantUML @startregex: each line's regex drawn as a railroad track, with classes, escapes,
groups, choices, and quantifiers. Railroad rules with no name draw no name =.
PlantUML @startchen: entity-relationship diagrams in Chen notation, with weak entities,
identifying relationships, key, derived, multi-valued, and composite attributes,
cardinalities, total participation, and specializations.
PlantUML network diagrams (nwdiag): networks with addresses, hosts with shapes and
descriptions, groups, and peer links.
PlantUML @startchronology: [Event] happens on DATE events drawn as a timeline in date
order.
PlantUML timing diagrams: robust, concise, rectangle, binary, clock, and analog signals,
absolute, relative, named, clock-based, and date moments, hidden and undefined states,
messages, constraints, highlights, and notes, drawn on a time axis in SVG, PNG, and text.
Notes on composite states in state diagrams, and class diagram notes with no class
(note "text"), which draw as a note box of their own.
Mermaid themes: a diagram's theme and themeVariables (including fontSize) from its
frontmatter config: or an %%{init}%% directive set its colors in SVG, PNG, and the editor,
for all 11 Mermaid 12.3 themes; an unknown theme name is a warning. Pie slices and the
sections of mindmaps, timelines, radar charts, and treemaps take the theme's pie and cScale colors.
sirene update replaces the running binary with the latest release (--check, --to VERSION, --yes), checked against SHA256SUMS and its build provenance; it refuses for a
Homebrew or cargo install binary and names the command to use instead.
Mermaid state diagrams (stateDiagram, stateDiagram-v2) in every command and in the
editor, where the drawing is read-only: states, transitions, [*], composite states,
concurrent regions, fork, join, and choice, notes, direction, and styling.
Mermaid class diagrams (classDiagram, classDiagram-v2), read-only in the editor: classes
with attribute and method compartments, annotations, generics, every relation with its
markers, cardinalities, and label, namespaces, notes, and styling.
Mermaid ER diagrams (erDiagram), read-only in the editor: entities with attribute columns
(type, name, keys, comment), aliases, relationships with crow's-foot markers in symbol or word
form, and styling.
Mermaid git graphs (gitGraph), read-only in the editor: commits, branches, checkout, merges,
and cherry-picks on lanes in each direction (LR, TB, BT), with commit types and tags; in
text, one commit per row as git log --graph draws them.
Mermaid timelines (timeline, LR and TD), read-only in the editor: periods with events,
continuation lines, sections with their own colors, <br>, and wrapping, in images and text.
Mermaid sequence diagrams (sequenceDiagram), read-only in the editor: participants, actors,
and the typed shapes, every message arrow, self-messages, activations, notes, loop, alt, opt, par, critical, break, and rect blocks, box groups, create and destroy,
and autonumber, in images and text.
Mermaid pie charts (pie), read-only in the editor: slices with percentages, a legend, showData, and a title; in text, a table with a bar per slice.
Mermaid gantt charts (gantt), read-only in the editor: tasks with after, until,
durations, and tags (active, done, crit, milestone, vert), sections, excludes, includes, weekend, inclusiveEndDates, todayMarker, topAxis, compact rows, and any
dayjs dateFormat and d3 axisFormat, also settable in frontmatter or a directive.
Mermaid mindmaps (mindmap), read-only in the editor: a tree built from indentation, every
node shape, markdown strings, and ::: classes, drawn out to both sides of the root with a
color per branch; in text, an outline of the tree.
Mermaid user journeys (journey), read-only in the editor: tasks in sections with a score
from 1 to 5 drawn as a face, and actors as colored dots with a legend; in text, a score bar per
task.
Mermaid quadrant charts (quadrantChart), read-only in the editor: axis and quadrant labels,
and points styled directly or by classDef (radius, color, stroke-color, stroke-width); in text, the points plotted by name in a box split in four.
Mermaid XY charts (xychart-beta, xychart), read-only in the editor: bar and line series
over category or numeric x-axes, vertical or horizontal, with axis titles and ranges, point
labels, and a legend for named series; in text, a row per position with bars and markers.
Mermaid requirement diagrams (requirementDiagram), read-only in the editor: every
requirement type and elements as boxes with their fields, the seven relationship types in
either direction, classes, styles, and direction.
Mermaid kanban boards (kanban), read-only in the editor: columns of cards with assigned, ticket, and priority metadata, drawn with a priority stripe; in text, a box per column.
Mindmaps read @{ ... } node metadata and warn that it is not used.
Mermaid packet diagrams (packet, packet-beta), read-only in the editor: bit ranges, single
bits, and +count fields in rows of bitsPerRow, with bit numbers and bitOrder: descending;
in text, the RFC header layout.
Mermaid radar charts (radar-beta), read-only in the editor: axes, curves with listed or
keyed values, min, max, ticks, circle or polygon graticule, a legend, and the
frontmatter radar config; in text, a bar per axis and curve.
Mermaid sankey diagrams (sankey-beta, sankey), read-only in the editor: CSV rows of flows
laid out as d3-sankey does, with linkColor, nodeAlignment, showValues, prefix, and suffix; in text, each node's outgoing flows with bars.
Mermaid treemaps (treemap-beta, treemap), read-only in the editor: sections and leaves
nested by indentation, laid out as d3's squarified treemap, with classDef styles and d3 valueFormat; in text, an outline with a bar per item.
Mermaid block diagrams (block-beta, block), read-only in the editor: blocks in a grid of columns with widths and space, nested block groups, block arrows, edges, and styles,
placed as Mermaid places them; in text, the grid with the edges listed below.
Mermaid architecture diagrams (architecture-beta), read-only in the editor: services with
their icons (cloud, database, disk, internet, server), junctions, nested groups,
edges by side with arrows, labels, and {group} ends, and align, placed on a grid from
the edge sides; in text, boxes with the icon name.
Mermaid C4 diagrams (C4Context, C4Container, C4Component, C4Dynamic, C4Deployment), read-only in the editor: people, systems, containers, and components with Db, Queue, and _Ext variants, nested boundaries and deployment nodes, relations with
technology, UpdateElementStyle, UpdateRelStyle, and UpdateLayoutConfig, in Mermaid's
colors and row layout; in text, the boxes with the relations listed below.
Mermaid ZenUML diagrams (zenuml), drawn as sequence diagrams and read-only in the editor:
annotated and aliased participants, async messages, sync calls with bodies, replies from
assignments and return, creations with new, @Starter, and if/else, loops, opt, par, and try/catch/finally fragments; calls with no caller come in from the left.
Mermaid info diagrams (info, showInfo), drawn as sirene's version.
Mermaid ishikawa diagrams (ishikawa-beta), read-only in the editor: the effect in a head
at the end of a spine, causes on bones above and below, and sub-causes nested by
indentation; in text, an outline.
Mermaid venn diagrams (venn-beta), read-only in the editor: sets, unions, sizes, labels, text nodes, and style, laid out as venn.js does for Mermaid; in text, each set and
overlap with its text nodes.
Mermaid Wardley maps (wardley-beta), read-only in the editor: anchors and components
placed by visibility and evolution, custom evolution stages, size, links with flows and
labels, evolve trends, pipeline blocks, (build), (buy), (outsource), (market),
and (inertia), notes, annotations, and accelerators; in text, the components plotted over
the stages with the rest listed below.
Mermaid tree views (treeView-beta), read-only in the editor: files and directories nested
by indentation or box-drawing characters, :::highlight, ## descriptions, the built-in file and folder icons, and the treeView frontmatter config; in text, the tree as tree
prints it.
Mermaid use case diagrams (usecase-beta), read-only in the editor: actors (stick, hollow,
and awesome figures), ellipse and rectangle use cases, business marks, stereotypes, system
boundaries (rect and package), associations with every marker, include, extend,
generalization, edge ids and animation, notes, JSON tables, classes, and styles.
Mermaid railroad diagrams in all four notations (railroad-ebnf-beta, railroad-abnf-beta, railroad-peg-beta, and the railroad-beta constructors), read-only in the editor:
terminals, non-terminals, special sequences, sequences, choices, optionals, repetition,
ABNF repeats and %x numbers, EBNF exceptions, and PEG predicates; in text, boxed
elements on a track with branches, bypasses, and loops.
Mermaid swimlane diagrams (swimlane-beta), read-only in the editor: flowcharts whose
top-level subgraphs are lanes side by side across the flow, with an untitled lane for
nodes outside every lane.
Mermaid Cynefin diagrams (cynefin-beta), read-only in the editor: items in the five
domains, transitions between them, and showDomainDescriptions; in text, the quadrants in a
box with confusion in the middle and the transitions listed below.
Mermaid event modeling diagrams (eventmodeling), read-only in the editor: time and reset
frames in swimlanes by type and namespace, inferred and ->> relations, inline data and
data blocks; in text, the lanes as rows of boxes with vertical arrows between them.
Collapsed flowchart subgraphs (id@{ view: collapsed }) are drawn as one node with the
subgraph's title, a dashed rule, and three dots; edges into the subgraph end at that node.
Mermaid agentflow diagrams (agentflow-beta), read-only in the editor: flow containers
(collapsible with @{ view: collapsed }), global blocks, connector nodes, agentflow's
shape aliases (task, tool, input, decision, refdoc, action), and -->, --x, and -.- edges; removed shapes are errors and other Mermaid shapes warnings, both drawn rounded.
Markdown blocks are no longer skipped as another diagram type: every Mermaid 12.3 type is
drawn.
Labels decode HTML entities such as as well as Mermaid's #nbsp;.
THIRD-PARTY-NOTICES with the licenses of the code sirene ports (venn.js, fmin, d3-sankey,
and other d3 modules, Day.js, Mermaid) and the Noto Sans fonts. Release tarballs, the macOS
app, and the published crates now include it along with LICENSE-MIT and LICENSE-APACHE.
PlantUML and DOT examples in examples/, and a PlantUML page in the guide.
Changed
Every flowchart shape has its own outline, as Mermaid 12.3 draws it: documents, paper tape,
delay, side and lined cylinders, display, divided and window panes, loop limit, stacked,
stored-data, tagged and lined rectangles, hourglass, bolt, braces, datastore, folder, bucket,
console, browser, person, bang, and cloud were drawn as rectangles before. Hourglasses and
bolts show no label.
In ASCII, start and stop circles (sm-circ, f-circ, fr-circ) are one character, a fork
is a heavy bar, and an unlabeled diamond is ◇.
Fixed
brew install --cask sirene no longer fails with "calling depends_on macos: :catalina is
disabled"; the cask drops its depends_on macos line.
The labels at an edge's ends (class and ER cardinalities, DOT headlabel and taillabel) no
longer run past the edge of an image: the drawing grows to hold them.
A stroke-width over 32px is drawn 32px wide; a wider line and its arrowheads ran off the
image.
A blank diagram title no longer prints an empty line in text output.
Deeply nested sources no longer overflow the stack: blocks, indented levels, and JSON values
are read 64 deep (block diagrams 12), and a deeper one is one error.
A gantt chart whose excludes names every day no longer hangs; it is an error and the excludes is ignored. Long after chains are dated in one visit per task, and a task waiting
on a task with a bad date is left out without a second error.
Text output of a very large drawing is cut off at 2^22 cells with a line saying so, in place
of an overflow or an allocation failure.
Architecture diagrams with many groups lay out in time proportional to their size.
A diagram reports at most 500 problems, then one line counting the rest.
Graphs with many edges between two ranks, such as a & b & ... --> c & d & ..., lay out in
milliseconds; 1,600 such edges took seconds and 22,500 did not finish.
A file starting with a byte order mark draws as it does without one; before, its header or
frontmatter was not found.
Long flowcharts and large subgraphs read, lay out, and draw in time near linear in their
size; a 2,000-node chain took several seconds.
Long state diagrams, mindmaps, pie charts, and sankey diagrams read and draw in time near
linear in their size; 10,000 sankey flows took tens of seconds.
A chain of subgraphs draws straight down; each subgraph sat a little right of the one before,
so a long chain drew a very wide, slow image.
DOT labels decode HTML entities, including &#NNN; and &#xHH;, in plain labels as well as
HTML ones. An unclosed string or HTML string keeps its last character.
A DOT cluster starts with the graph attributes set around it before it, as in Graphviz, and a # line after a byte order mark is a comment.
Mermaid labels decode hex entities such as ♥, and &9829; without its # is text.
The editor draws a DOT graph on its bgcolor, as the other commands do.
An init directive that cannot be read, malformed or nested too deep, is a warning; it was
ignored without one.
A graph's title stays centered when an edge's end label widens the drawing on one side.
A Mermaid source with lone \r line endings reads line by line, as in Mermaid, and diagnostics
count a lone \r as a line break.
PlantUML no longer crashes on an activity arrow -][>, a chain of as aliases, a Gantt D+N
past the end of time, or today is [Task]'s end. Repeated split blocks, closed-day ranges,
long dependency chains, and large sequence, state, WBS, and multi-line action sources read in
time near linear in their size.
PlantUML kinds are picked past note, legend, and skinparam bodies, and from colored actions
and actions with a colon; analog picks a timing diagram.
PlantUML class and component names that match a keyword or a setting (Exception <|-- X, Set --> Y) are read as links; ns::Foo : member goes to ns::Foo; a link end later declared
as a package or container is not also drawn as a node.
note on link: x, a one-line <style>, and note left on link no longer swallow the rest of
the file.
PlantUML activity arrows before else, endif, and end fork label only their own branch; (no) elseif is read; an action ending in an HTML tag is not cut short.
PlantUML sequence -[#red]-> is dashed, note left after a message follows order, and autonumber resume keeps the numbering.
A PlantUML composite state opened twice keeps its regions, and a description before it is its
title. A mindmap line with no parent leaves out the lines under it.
Gantt ends D+N matches ends DATE, saturday are open reopens Saturday, and inside a
task name is part of the name, an end before the start is an error, and errors point at the
clause that caused them.
PlantUML sequence diagrams read <style> blocks, and kind detection skips their bodies; Style -up-> Page and other directional links from a setting-named element are links.
PlantUML activity elseif after else is an error, and a malformed elseif or a break
outside a loop no longer cuts the flow.
Large PlantUML class and component diagrams with many packages, timing diagrams with many has lines, and JSON or YAML tables with many nested rows no longer take quadratic time.
A PlantUML element named note can be linked (note --> A), and repeated <note> bodies on
one file-tree entry are joined in place.
PlantUML JSON reads surrogate-pair escapes as one character, stops a short \u escape at
the closing quote, and accepts numbers beyond f64 range.
PlantUML chronology dates past the end of their month (2023-02-29) are errors, a timing
clock's bad period or pulse gets its own error, and the older activity syntax reports
one error instead of one per line.
Notes on charts with many nodes are placed in linear time.
PlantUML sequence diagrams ignore scale, skin, and set with a warning instead of an
error, and preprocessor lines such as !$a = 1 are named in full in their warning.
PlantUML links read bold ==> and dotted ~~> shafts, and EBNF reads ISO { a }- as one
or more a.
PlantUML analog between errors say whether the bounds are out of order or out of range.