@diagrammo/dgmo 0.8.12 → 0.8.14

package/docs/guide/chart-er.md

@@ -0,0 +1,218 @@
+# Entity Relationship
+
+```dgmo
+er Pirate Fleet
+
+ships
+  id int pk
+  name varchar
+  ship_type varchar
+  cannons int
+  1-aboard-* crew_members
+  1-1 captains
+  1-carries-* treasure
+
+captains
+  id int pk
+  name varchar
+  ship_id int fk
+  bounty int
+  ?-frequents-1 ports
+
+crew_members
+  id int pk
+  name varchar
+  ship_id int fk
+  role varchar nullable
+
+treasure
+  id int pk
+  name varchar
+  value int
+  ship_id int fk nullable
+
+ports
+  id int pk
+  name varchar
+  region varchar unique
+  1-docks-* ships
+```
+
+## Overview
+
+ER diagrams render database-style entity-relationship boxes with columns, data types, and constraint icons. Tables connect via relationships with crow's foot cardinality markers. Layout is automatic via Dagre.
+
+## Syntax
+
+```
+er Diagram Title
+notation crowsfoot
+
+TableName (color)
+  column_name type [constraints]
+
+SourceTable 1--* TargetTable : label
+```
+
+## Settings
+
+| Key        | Description             | Default     |
+| ---------- | ----------------------- | ----------- |
+| `chart`    | Must be `er`            | —           |
+| `title`    | Diagram title           | None        |
+| `notation` | `crowsfoot` or `labels` | `crowsfoot` |
+
+## Tables
+
+Declare a table on an unindented line. Columns are indented below:
+
+```
+ships
+  id int pk
+  name varchar
+  cannons int
+```
+
+### Colors
+
+Colors are auto-assigned from the palette. Override with a color name in parentheses:
+
+```
+ships (blue)
+treasure (red)
+```
+
+## Columns
+
+Indented lines under a table are parsed as columns.
+
+### Format
+
+```
+  column_name type constraints
+```
+
+All parts except the name are optional:
+
+```
+  id int pk           // name + type + constraint
+  name varchar        // name + type
+  active nullable     // name + constraint
+  notes               // name only
+```
+
+### Constraints
+
+Add constraints in square brackets. Multiple constraints are comma-separated:
+
+| Constraint | Icon | Meaning     |
+| ---------- | ---- | ----------- |
+| `pk`       | ♦    | Primary key |
+| `fk`       | →    | Foreign key |
+| `unique`   | ◆    | Unique      |
+| `nullable` | ○    | Nullable    |
+
+```
+  id int pk
+  name varchar unique nullable
+  ship_id int fk
+```
+
+## Relationships
+
+Relationships connect two tables with cardinality on each side.
+
+### Cardinality Values
+
+| Symbol | Meaning     | Crow's foot        |
+| ------ | ----------- | ------------------ |
+| `1`    | Exactly one | Perpendicular bar  |
+| `*`    | Many        | Three-pronged fork |
+| `?`    | Zero or one | Circle + bar       |
+
+### Syntax
+
+Use `1`, `*`, or `?` with dashes:
+
+```
+ships 1--* crew_members
+ports ?--1 captains
+ships 1--* treasure
+```
+
+Single dash also works:
+
+```
+ships 1-* crew_members
+```
+
+### Labels
+
+Add a label after a colon:
+
+```
+ships 1--* crew_members : sails on
+ships 1--1 captains : commanded by
+```
+
+## Notation Modes
+
+### Crow's Foot (default)
+
+Cardinality is shown as graphical markers at each end of the relationship line:
+
+- **One (1):** perpendicular bar
+- **Many (\*):** three-pronged fork
+- **Optional (?):** circle with perpendicular bar
+
+### Labels Mode
+
+Switch to text labels by adding `notation labels`:
+
+```
+er
+notation labels
+```
+
+This replaces crow's foot markers with text like `1`, `*`, and `0..1`.
+
+## Comments
+
+```
+// This line is ignored by the parser
+```
+
+## Complete Example
+
+```dgmo
+er Pirate Ports
+
+ports (blue)
+  id int pk
+  name varchar
+  region varchar unique
+
+ships
+  id int pk
+  name varchar
+  home_port int fk
+  cannons int
+
+captains (green)
+  id int pk
+  name varchar
+  ship_id int fk
+  bounty int
+
+raids
+  id int pk
+  ship_id int fk
+  port_id int fk
+  date date
+  plunder int nullable
+
+ports 1--* ships : home of
+ships 1--1 captains : commanded by
+ships 1--* raids : launched
+ports 1--* raids : targeted
+```

package/docs/guide/chart-flowchart.md

@@ -0,0 +1,102 @@
+# Flowchart
+
+```dgmo
+flowchart Pirate's Code
+
+(Sail Ho!) -> <Friend or Foe?>
+  -friend-> [Check Logs~] -> /Trade Rum/ -> [Celebrate]
+  -foe-> [Fire Cannons] -> [[Claim Loot]] -> [Celebrate]
+[Celebrate]->(Sail On)
+```
+
+## Overview
+
+Flowcharts use an indent-based syntax with shaped nodes and labeled arrows. Nodes are created automatically from their shape delimiters — just write the flow and Diagrammo handles the layout.
+
+## Syntax
+
+```
+flowchart Chart Title
+direction-lr
+
+(Start) -> [Step] -> <Decision?>
+  -yes-> [Action] -> (End)
+  -no-> [Other Action]
+```
+
+## Settings
+
+| Key            | Description                                     | Default |
+| -------------- | ----------------------------------------------- | ------- |
+| `chart`        | Must be `flowchart`                             | Yes     |
+| `title`        | Diagram title                                   | None    |
+| `direction-lr` | Left-to-right layout (default is top-to-bottom) | off     |
+
+## Node Shapes
+
+Each shape has its own delimiter syntax:
+
+| Shape      | Syntax      | Appearance          | Typical Use         |
+| ---------- | ----------- | ------------------- | ------------------- |
+| Terminal   | `(Label)`   | Rounded rectangle   | Start / End         |
+| Process    | `[Label]`   | Rectangle           | Actions / Steps     |
+| Decision   | `<Label?>`  | Diamond             | Yes/No branching    |
+| I/O        | `/Label/`   | Parallelogram       | Input / Output      |
+| Subroutine | `[[Label]]` | Double-bordered box | Reusable procedures |
+| Document   | `[Label~]`  | Wavy-bottom box     | Files / Reports     |
+
+## Arrows and Edge Labels
+
+Connect nodes with `->`. Add labels between dashes:
+
+```
+[A] -> [B]
+[A] -yes-> [B]
+[A] -no-> [C]
+```
+
+## Branching with Indentation
+
+Indent continuation lines to branch from a decision node:
+
+```
+<Valid?>
+  -yes-> [Process] -> (Done)
+  -no-> [Show Error] -> /Retry/
+```
+
+The indented lines connect back to the last node at the parent indent level, creating branching paths without explicit wiring.
+
+## Node Colors
+
+Add a color name in parentheses at the end of a node label:
+
+```
+(Start(green)) -> [Process(blue)] -> (End(red))
+```
+
+## Edge Colors
+
+Add a color in parentheses inside the arrow label:
+
+```
+<OK?> -yes(green)-> [Continue]
+<OK?> -no(red)-> [Abort]
+```
+
+## Comments
+
+```
+// This line is ignored by the parser
+(Start) -> [Step] // inline comments are NOT supported
+```
+
+## Complete Example
+
+```dgmo
+flowchart Color Demo
+
+(Start(green)) -> [Parse Input] -> <Valid?(blue)>
+  -yes(green)-> [Process(teal)] -> (Success(green))
+  -no(red)-> [Error Handler(red)] -> /Log Error(orange)/ -> (Failure(red))
+```

package/docs/guide/chart-function.md

@@ -0,0 +1,56 @@
+# Function Plot
+
+```dgmo
+function Cannonball Trajectories by Elevation
+x-label Distance (meters)
+y-label Height (meters)
+x 0 to 250
+
+15 degrees(blue): -0.001*x^2 + 0.27*x
+30 degrees(green): -0.002*x^2 + 0.58*x
+45 degrees(red): -0.003*x^2 + 0.75*x
+```
+
+## Syntax
+
+```
+function Chart Title
+x-label X Axis Label
+y-label Y Axis Label
+x: min to max
+
+Label(color): expression
+```
+
+## Metadata Keys
+
+| Key       | Description                           | Required |
+| --------- | ------------------------------------- | -------- |
+| `chart`   | Must be `function`                    | Yes      |
+| `title`   | Chart title displayed above the chart | No       |
+| `x-label` | Label for the X axis                  | No       |
+| `y-label` | Label for the Y axis                  | No       |
+| `x`       | X range in format `min to max`        | No       |
+
+## Data Format
+
+Each data line defines a named function with an optional color and a math expression:
+
+```
+Label(color): expression
+```
+
+Expressions support:
+
+- Basic arithmetic: `+`, `-`, `*`, `/`
+- Exponents: `x^2`, `x^3`
+- The variable `x` represents the X axis value
+
+## Colors
+
+Specify colors in parentheses after the function name:
+
+```
+Parabola(blue): x^2
+Linear(red): 2*x + 1
+```

package/docs/guide/chart-funnel.md

@@ -0,0 +1,38 @@
+# Funnel Chart
+
+```dgmo
+funnel Pirate Recruitment Pipeline
+
+Port Visitors: 1000
+Tavern Recruits: 500
+Crew Trials: 200
+Sworn Pirates: 100
+Veteran Buccaneers: 50
+```
+
+## Syntax
+
+```
+funnel Chart Title
+
+Label: value
+```
+
+## Metadata Keys
+
+| Key     | Description                           | Required |
+| ------- | ------------------------------------- | -------- |
+| `chart` | Must be `funnel`                      | Yes      |
+| `title` | Chart title displayed above the chart | No       |
+
+## Data Format
+
+Each data line defines a stage with its value. Stages are displayed top-to-bottom with widths proportional to their values:
+
+```
+Visitors: 1000
+Signups: 500
+Purchases: 100
+```
+
+List stages from largest to smallest for a classic funnel shape.