sirena 0.1.0

data/examples/class_diagram/02-relationships.svg

@@ -0,0 +1,129 @@
+<svg
+ width="811.0"
+ height="674.0"
+ viewBox="0 0 811.0 674"
+ version="1.2"
+ xmlns="http://www.w3.org/2000/svg"
+>
+<g id="defs"/>
+<g id="rel-Mammal_to_Animal">
+  <line stroke="#000000" stroke-width="2" x1="300.0" y1="127.56420233463035" x2="196.0" y2="147.7976653696498"/>
+  <polygon fill="#000000" stroke="#000000" stroke-width="2" points="196.0,147.7976653696498 205.4557258882203,151.0517778334163 203.5460070045035,141.2358227711121"/>
+</g>
+<g id="rel-Bird_to_Animal">
+  <line stroke="#000000" stroke-width="2" x1="550.0" y1="120.74396135265701" x2="196.0" y2="154.94685990338164"/>
+  <polygon fill="#000000" stroke="#000000" stroke-width="2" points="196.0,154.94685990338164 205.10096526003713,159.09082314351747 204.1392600683251,149.13717440929776"/>
+</g>
+<g id="rel-Dog_to_Mammal">
+  <line stroke="#000000" stroke-width="2" x1="196.0" y1="262.35019455252916" x2="300.0" y2="177.36964980544747"/>
+  <polygon fill="#000000" stroke="#000000" stroke-width="2" points="300,177.36964980544747 290.13011958355173,178.9775865470548 296.4575738576862,186.7211853492099"/>
+</g>
+<g id="rel-Cat_to_Mammal">
+  <line stroke="#000000" stroke-width="2" x1="373.72727272727275" y1="250.0" x2="377.1818181818182" y2="174.0"/>
+  <polygon fill="#000000" stroke="#000000" stroke-width="2" points="377.1818181818182,174 371.7937336019469,182.4242830294425 381.7834190040499,182.878359638629"/>
+</g>
+<g id="rel-Eagle_to_Bird">
+  <line stroke="#000000" stroke-width="2" x1="629.0" y1="250.0" x2="635.3333333333334" y2="174.0"/>
+  <polygon fill="#000000" stroke="#000000" stroke-width="2" points="635.3333333333334,174 629.631409589881,182.21511202746822 639.5968671723297,183.04556682600563"/>
+</g>
+<g id="rel-Penguin_to_Bird">
+  <line stroke="#000000" stroke-width="2" x1="190.0" y1="458.20557156580213" x2="550.0" y2="181.54851104707012"/>
+  <polygon fill="#000000" stroke="#000000" stroke-width="2" points="550,181.54851104707012 540.0865104828309,182.8610374631773 546.1799364609025,190.79010801714284"/>
+</g>
+<g id="rel-Owner_to_Animal">
+  <line stroke="#000000" stroke-width="2" x1="334.2" y1="450.0" x2="205.13333333333333" y2="274.0"/>
+  <text fill="#000000" x="269.66666666666663" y="357.0" text-anchor="middle" font-family="Arial, sans-serif" font-size="11">owns</text>
+  <text fill="#000000" x="339.2" y="445.0" font-family="Arial, sans-serif" font-size="10">1</text>
+  <text fill="#000000" x="200.13333333333333" y="269.0" text-anchor="end" font-family="Arial, sans-serif" font-size="10">*</text>
+</g>
+<g id="class-Animal">
+  <rect fill="#ffffff" stroke="#000000" stroke-width="2" x="50.0" y="50.0" width="146.0" height="224.0" rx="3.0" ry="3.0"/>
+  <text fill="#000000" x="123.0" y="60.0" text-anchor="middle" font-family="Arial, sans-serif" font-size="16" font-weight="bold">Animal</text>
+  <line stroke="#000000" stroke-width="1" x1="50.0" y1="83.0" x2="196.0" y2="83.0"/>
+  <text fill="#000000" x="60.0" y="93.0" font-family="monospace" font-size="12">+ name: String</text>
+  <text fill="#000000" x="60.0" y="111.0" font-family="monospace" font-size="12">+ age: int</text>
+  <text fill="#000000" x="60.0" y="129.0" font-family="monospace" font-size="12">+ species: String</text>
+  <text fill="#000000" x="60.0" y="147.0" font-family="monospace" font-size="12">+ void</text>
+  <text fill="#000000" x="60.0" y="165.0" font-family="monospace" font-size="12">+ void</text>
+  <text fill="#000000" x="60.0" y="183.0" font-family="monospace" font-size="12">+ void</text>
+  <line stroke="#000000" stroke-width="1" x1="50.0" y1="206.0" x2="196.0" y2="206.0"/>
+  <text fill="#000000" x="60.0" y="216.0" font-family="monospace" font-size="12">+ makeSound()</text>
+  <text fill="#000000" x="60.0" y="234.0" font-family="monospace" font-size="12">+ eat(food Food)</text>
+  <text fill="#000000" x="60.0" y="252.0" font-family="monospace" font-size="12">+ sleep()</text>
+</g>
+<g id="class-Mammal">
+  <rect fill="#ffffff" stroke="#000000" stroke-width="2" x="300.0" y="50.0" width="160.0" height="124.0" rx="3.0" ry="3.0"/>
+  <text fill="#000000" x="380.0" y="60.0" text-anchor="middle" font-family="Arial, sans-serif" font-size="16" font-weight="bold">Mammal</text>
+  <line stroke="#000000" stroke-width="1" x1="300.0" y1="83.0" x2="460.0" y2="83.0"/>
+  <text fill="#000000" x="310.0" y="93.0" font-family="monospace" font-size="12">+ furColor: String</text>
+  <text fill="#000000" x="310.0" y="111.0" font-family="monospace" font-size="12">+ warmBlooded: bool</text>
+  <text fill="#000000" x="310.0" y="129.0" font-family="monospace" font-size="12">+ void</text>
+  <line stroke="#000000" stroke-width="1" x1="300.0" y1="152.0" x2="460.0" y2="152.0"/>
+  <text fill="#000000" x="310.0" y="162.0" font-family="monospace" font-size="12">+ giveBirth()</text>
+</g>
+<g id="class-Bird">
+  <rect fill="#ffffff" stroke="#000000" stroke-width="2" x="550.0" y="50.0" width="181.0" height="124.0" rx="3.0" ry="3.0"/>
+  <text fill="#000000" x="640.5" y="60.0" text-anchor="middle" font-family="Arial, sans-serif" font-size="16" font-weight="bold">Bird</text>
+  <line stroke="#000000" stroke-width="1" x1="550.0" y1="83.0" x2="731.0" y2="83.0"/>
+  <text fill="#000000" x="560.0" y="93.0" font-family="monospace" font-size="12">+ canFly: bool</text>
+  <text fill="#000000" x="560.0" y="111.0" font-family="monospace" font-size="12">+ featherColor: String</text>
+  <text fill="#000000" x="560.0" y="129.0" font-family="monospace" font-size="12">+ void</text>
+  <line stroke="#000000" stroke-width="1" x1="550.0" y1="152.0" x2="731.0" y2="152.0"/>
+  <text fill="#000000" x="560.0" y="162.0" font-family="monospace" font-size="12">+ layEggs()</text>
+</g>
+<g id="class-Dog">
+  <rect fill="#ffffff" stroke="#000000" stroke-width="2" x="50.0" y="250.0" width="146.0" height="144.0" rx="3.0" ry="3.0"/>
+  <text fill="#000000" x="123.0" y="260.0" text-anchor="middle" font-family="Arial, sans-serif" font-size="16" font-weight="bold">Dog</text>
+  <line stroke="#000000" stroke-width="1" x1="50.0" y1="283.0" x2="196.0" y2="283.0"/>
+  <text fill="#000000" x="60.0" y="293.0" font-family="monospace" font-size="12">+ breed: String</text>
+  <text fill="#000000" x="60.0" y="311.0" font-family="monospace" font-size="12">+ void</text>
+  <text fill="#000000" x="60.0" y="329.0" font-family="monospace" font-size="12">+ void</text>
+  <line stroke="#000000" stroke-width="1" x1="50.0" y1="352.0" x2="196.0" y2="352.0"/>
+  <text fill="#000000" x="60.0" y="362.0" font-family="monospace" font-size="12">+ bark()</text>
+  <text fill="#000000" x="60.0" y="380.0" font-family="monospace" font-size="12">+ fetch(item Item)</text>
+</g>
+<g id="class-Cat">
+  <rect fill="#ffffff" stroke="#000000" stroke-width="2" x="300.0" y="250.0" width="140.0" height="164.0" rx="3.0" ry="3.0"/>
+  <text fill="#000000" x="370.0" y="260.0" text-anchor="middle" font-family="Arial, sans-serif" font-size="16" font-weight="bold">Cat</text>
+  <line stroke="#000000" stroke-width="1" x1="300.0" y1="283.0" x2="440.0" y2="283.0"/>
+  <text fill="#000000" x="310.0" y="293.0" font-family="monospace" font-size="12">+ indoor: bool</text>
+  <text fill="#000000" x="310.0" y="311.0" font-family="monospace" font-size="12">+ lives: int</text>
+  <text fill="#000000" x="310.0" y="329.0" font-family="monospace" font-size="12">+ void</text>
+  <text fill="#000000" x="310.0" y="347.0" font-family="monospace" font-size="12">+ void</text>
+  <line stroke="#000000" stroke-width="1" x1="300.0" y1="370.0" x2="440.0" y2="370.0"/>
+  <text fill="#000000" x="310.0" y="380.0" font-family="monospace" font-size="12">+ meow()</text>
+  <text fill="#000000" x="310.0" y="398.0" font-family="monospace" font-size="12">+ purr()</text>
+</g>
+<g id="class-Eagle">
+  <rect fill="#ffffff" stroke="#000000" stroke-width="2" x="550.0" y="250.0" width="146.0" height="144.0" rx="3.0" ry="3.0"/>
+  <text fill="#000000" x="623.0" y="260.0" text-anchor="middle" font-family="Arial, sans-serif" font-size="16" font-weight="bold">Eagle</text>
+  <line stroke="#000000" stroke-width="1" x1="550.0" y1="283.0" x2="696.0" y2="283.0"/>
+  <text fill="#000000" x="560.0" y="293.0" font-family="monospace" font-size="12">+ wingSpan: float</text>
+  <text fill="#000000" x="560.0" y="311.0" font-family="monospace" font-size="12">+ void</text>
+  <text fill="#000000" x="560.0" y="329.0" font-family="monospace" font-size="12">+ void</text>
+  <line stroke="#000000" stroke-width="1" x1="550.0" y1="352.0" x2="696.0" y2="352.0"/>
+  <text fill="#000000" x="560.0" y="362.0" font-family="monospace" font-size="12">+ hunt()</text>
+  <text fill="#000000" x="560.0" y="380.0" font-family="monospace" font-size="12">+ soar()</text>
+</g>
+<g id="class-Penguin">
+  <rect fill="#ffffff" stroke="#000000" stroke-width="2" x="50.0" y="450.0" width="140.0" height="124.0" rx="3.0" ry="3.0"/>
+  <text fill="#000000" x="120.0" y="460.0" text-anchor="middle" font-family="Arial, sans-serif" font-size="16" font-weight="bold">Penguin</text>
+  <line stroke="#000000" stroke-width="1" x1="50.0" y1="483.0" x2="190.0" y2="483.0"/>
+  <text fill="#000000" x="60.0" y="493.0" font-family="monospace" font-size="12">+ void</text>
+  <text fill="#000000" x="60.0" y="511.0" font-family="monospace" font-size="12">+ void</text>
+  <line stroke="#000000" stroke-width="1" x1="50.0" y1="534.0" x2="190.0" y2="534.0"/>
+  <text fill="#000000" x="60.0" y="544.0" font-family="monospace" font-size="12">+ swim()</text>
+  <text fill="#000000" x="60.0" y="562.0" font-family="monospace" font-size="12">+ slide()</text>
+</g>
+<g id="class-Owner">
+  <rect fill="#ffffff" stroke="#000000" stroke-width="2" x="300.0" y="450.0" width="174.0" height="144.0" rx="3.0" ry="3.0"/>
+  <text fill="#000000" x="387.0" y="460.0" text-anchor="middle" font-family="Arial, sans-serif" font-size="16" font-weight="bold">Owner</text>
+  <line stroke="#000000" stroke-width="1" x1="300.0" y1="483.0" x2="474.0" y2="483.0"/>
+  <text fill="#000000" x="310.0" y="493.0" font-family="monospace" font-size="12">+ name: String</text>
+  <text fill="#000000" x="310.0" y="511.0" font-family="monospace" font-size="12">+ address: String</text>
+  <text fill="#000000" x="310.0" y="529.0" font-family="monospace" font-size="12">+ pets: List~Animal~</text>
+  <text fill="#000000" x="310.0" y="547.0" font-family="monospace" font-size="12">+ void</text>
+  <line stroke="#000000" stroke-width="1" x1="300.0" y1="570.0" x2="474.0" y2="570.0"/>
+  <text fill="#000000" x="310.0" y="580.0" font-family="monospace" font-size="12">+ adoptPet(pet Animal)</text>
+</g>
+</svg>

data/examples/class_diagram/README.adoc

@@ -0,0 +1,93 @@
+= Class Diagram Examples
+
+== Purpose
+
+Class diagrams visualize the structure of object-oriented systems, showing classes, their attributes, methods, and relationships. They are fundamental for software design, architecture documentation, and understanding system structure.
+
+== When to Use
+
+* Object-oriented design and architecture documentation
+* Data model and entity relationship visualization
+* Interface and abstract class hierarchies
+* Design pattern documentation
+* System structure and component relationships
+
+== Syntax Overview
+
+[source,mermaid]
+----
+classDiagram
+    class Animal {
+        +String name
+        +int age
+        +makeSound() void
+    }
+    
+    class Dog {
+        +String breed
+        +bark() void
+    }
+    
+    Animal <|-- Dog
+----
+
+**Class Definition**: Define classes with attributes and methods
+
+**Visibility**:
+- `+` - Public
+- `-` - Private
+- `#` - Protected
+- `~` - Package/Internal
+
+**Relationship Types**:
+- `<|--` - Inheritance
+- `*--` - Composition
+- `o--` - Aggregation
+- `-->` - Association
+- `..>` - Dependency
+- `..|>` - Realization
+
+== Examples
+
+=== 01: Basic Classes
+
+Demonstrates a complete class hierarchy with inheritance, showing the Animal base class with Mammal and Bird subclasses, and an Owner class with composition.
+
+**File**: link:01-basic-classes.mmd[01-basic-classes.mmd]
+
+[source,mermaid]
+----
+include::01-basic-classes.mmd[]
+----
+
+image::01-basic-classes.svg[]
+
+== Features Demonstrated
+
+[%header,cols="1,1"]
+|===
+| Feature | Example
+
+| Class definition with attributes
+| 01
+
+| Methods and signatures
+| 01
+
+| Inheritance relationships
+| 01
+
+| Association with cardinality
+| 01
+
+| Multi-level hierarchy
+| 01
+
+| Generic types
+| 01
+|===
+
+== Additional Resources
+
+* link:../../README.adoc[Main Documentation]
+* https://mermaid.js.org/syntax/classDiagram.html[Mermaid Class Diagram Documentation]

data/examples/er_diagram/01-basic-entities.mmd

@@ -0,0 +1,64 @@
+erDiagram
+    USER ||--o{ POST : writes
+    USER ||--o{ COMMENT : writes
+    POST ||--o{ COMMENT : has
+    POST }o--|| CATEGORY : belongs_to
+    POST }o--o{ TAG : tagged_with
+    USER ||--o{ LIKE : gives
+    POST ||--o{ LIKE : receives
+    COMMENT ||--o{ LIKE : receives
+
+    USER {
+        int id PK
+        string username UK
+        string email UK
+        string password_hash
+        datetime created_at
+        datetime updated_at
+        boolean is_active
+    }
+
+    POST {
+        int id PK
+        int user_id FK
+        int category_id FK
+        string title
+        text content
+        string slug UK
+        datetime published_at
+        datetime created_at
+        datetime updated_at
+        int view_count
+    }
+
+    COMMENT {
+        int id PK
+        int post_id FK
+        int user_id FK
+        int parent_id FK
+        text content
+        datetime created_at
+        datetime updated_at
+        boolean is_approved
+    }
+
+    CATEGORY {
+        int id PK
+        string name UK
+        string slug UK
+        text description
+    }
+
+    TAG {
+        int id PK
+        string name UK
+        string slug UK
+    }
+
+    LIKE {
+        int id PK
+        int user_id FK
+        int post_id FK
+        int comment_id FK
+        datetime created_at
+    }

data/examples/er_diagram/01-basic-entities.svg

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="400" height="200" viewBox="0 0 400 200" version="1.2" xmlns="http://www.w3.org/2000/svg">
+  <rect x="50" y="50" width="300" height="100" fill="#f0f0f0" stroke="#000000" stroke-width="2"/>
+  <text x="200" y="100" text-anchor="middle" font-family="Arial, sans-serif" font-size="14" fill="#000000">ER Diagram (parser needs fixes)</text>
+</svg>

data/examples/er_diagram/02-cardinality.mmd

@@ -0,0 +1,57 @@
+erDiagram
+    CUSTOMER ||--o{ ORDER : places
+    CUSTOMER {
+        int customer_id PK
+        string name
+        string email UK
+        string phone
+    }
+    
+    ORDER ||--|{ ORDER_ITEM : contains
+    ORDER {
+        int order_id PK
+        int customer_id FK
+        date order_date
+        decimal total_amount
+        string status
+    }
+    
+    ORDER_ITEM }o--|| PRODUCT : references
+    ORDER_ITEM {
+        int order_item_id PK
+        int order_id FK
+        int product_id FK
+        int quantity
+        decimal unit_price
+    }
+    
+    PRODUCT ||--o{ INVENTORY : tracked_in
+    PRODUCT {
+        int product_id PK
+        string name
+        string sku UK
+        decimal price
+        int category_id FK
+    }
+    
+    CATEGORY ||--o{ PRODUCT : categorizes
+    CATEGORY {
+        int category_id PK
+        string name
+        string description
+    }
+    
+    INVENTORY {
+        int inventory_id PK
+        int product_id FK
+        int warehouse_id FK
+        int quantity
+        date last_updated
+    }
+    
+    WAREHOUSE ||--o{ INVENTORY : stores
+    WAREHOUSE {
+        int warehouse_id PK
+        string name
+        string location
+    }

data/examples/er_diagram/02-cardinality.svg

@@ -0,0 +1,125 @@
+<svg
+ width="800.0"
+ height="630.0"
+ viewBox="0 0 800 630"
+ version="1.2"
+ xmlns="http://www.w3.org/2000/svg"
+>
+<g id="rel-CUSTOMER_to_ORDER">
+  <line stroke="#333333" stroke-width="2" x1="220.0" y1="110.0" x2="300.0" y2="120.0" stroke-dasharray="5,5"/>
+  <line stroke="#333333" stroke-width="2" x1="219.13175685787553" y1="116.94594513699568" x2="220.86824314212447" y2="103.05405486300432"/>
+  <circle fill="none" stroke="#333333" stroke-width="2" cx="293.05405486300435" cy="119.13175685787554" r="5.0"/>
+  <line stroke="#333333" stroke-width="2" x1="285.115831849295" y1="118.13947898116187" x2="296.95611510993984" y2="108.93036977843806"/>
+  <line stroke="#333333" stroke-width="2" x1="285.115831849295" y1="118.13947898116187" x2="300.0" y2="120.0"/>
+  <line stroke="#333333" stroke-width="2" x1="285.115831849295" y1="118.13947898116187" x2="294.3249410520188" y2="129.97976224180675"/>
+  <text fill="#000000" x="260.0" y="110.0" text-anchor="middle" font-family="Arial, sans-serif" font-size="11">places</text>
+</g>
+<g id="rel-ORDER_to_ORDER_ITEM">
+  <line stroke="#333333" stroke-width="2" x1="470.0" y1="120.0" x2="550.0" y2="120.0" stroke-dasharray="5,5"/>
+  <line stroke="#333333" stroke-width="2" x1="470.0" y1="127.0" x2="470.0" y2="113.0"/>
+  <line stroke="#333333" stroke-width="2" x1="550.0" y1="113.0" x2="550.0" y2="127.0"/>
+  <line stroke="#333333" stroke-width="2" x1="535.0" y1="120.0" x2="545.6066017177982" y2="109.39339828220179"/>
+  <line stroke="#333333" stroke-width="2" x1="535.0" y1="120.0" x2="550.0" y2="120.0"/>
+  <line stroke="#333333" stroke-width="2" x1="535.0" y1="120.0" x2="545.6066017177982" y2="130.6066017177982"/>
+  <text fill="#000000" x="510.0" y="115.0" text-anchor="middle" font-family="Arial, sans-serif" font-size="11">contains</text>
+</g>
+<g id="rel-ORDER_ITEM_to_PRODUCT">
+  <line stroke="#333333" stroke-width="2" x1="550.0" y1="205.0" x2="220.0" y2="235.0" stroke-dasharray="5,5"/>
+  <circle fill="none" stroke="#333333" stroke-width="2" cx="543.0287475547261" cy="205.63375022229764" r="5.0"/>
+  <line stroke="#333333" stroke-width="2" x1="549.3662497777024" y1="198.02874755472607" x2="550.6337502222976" y2="211.97125244527393"/>
+  <line stroke="#333333" stroke-width="2" x1="220.63375022229764" y1="241.97125244527393" x2="219.36624977770236" y2="228.02874755472607"/>
+  <text fill="#000000" x="385.0" y="215.0" text-anchor="middle" font-family="Arial, sans-serif" font-size="11">references</text>
+</g>
+<g id="rel-PRODUCT_to_INVENTORY">
+  <line stroke="#333333" stroke-width="2" x1="220.0" y1="320.0" x2="300.0" y2="320.0" stroke-dasharray="5,5"/>
+  <line stroke="#333333" stroke-width="2" x1="220.0" y1="327.0" x2="220.0" y2="313.0"/>
+  <circle fill="none" stroke="#333333" stroke-width="2" cx="293.0" cy="320.0" r="5.0"/>
+  <line stroke="#333333" stroke-width="2" x1="285.0" y1="320.0" x2="295.6066017177982" y2="309.39339828220176"/>
+  <line stroke="#333333" stroke-width="2" x1="285.0" y1="320.0" x2="300.0" y2="320.0"/>
+  <line stroke="#333333" stroke-width="2" x1="285.0" y1="320.0" x2="295.60660171779824" y2="330.6066017177982"/>
+  <text fill="#000000" x="260.0" y="315.0" text-anchor="middle" font-family="Arial, sans-serif" font-size="11">tracked_in</text>
+</g>
+<g id="rel-CATEGORY_to_PRODUCT">
+  <line stroke="#333333" stroke-width="2" x1="550.0" y1="385.0" x2="220.0" y2="235.0" stroke-dasharray="5,5"/>
+  <line stroke="#333333" stroke-width="2" x1="552.8966206101082" y1="378.62743465776174" x2="547.1033793898918" y2="391.37256534223826"/>
+  <circle fill="none" stroke="#333333" stroke-width="2" cx="226.37256534223823" cy="237.8966206101083" r="5.0"/>
+  <line stroke="#333333" stroke-width="2" x1="233.65549716193908" y1="241.20704416451775" x2="219.6105594984034" y2="246.47389578834364"/>
+  <line stroke="#333333" stroke-width="2" x1="233.65549716193908" y1="241.20704416451775" x2="220.0" y2="235.0"/>
+  <line stroke="#333333" stroke-width="2" x1="233.65549716193908" y1="241.20704416451775" x2="228.3886455381132" y2="227.16210650098208"/>
+  <text fill="#000000" x="385.0" y="305.0" text-anchor="middle" font-family="Arial, sans-serif" font-size="11">categorizes</text>
+</g>
+<g id="rel-WAREHOUSE_to_INVENTORY">
+  <line stroke="#333333" stroke-width="2" x1="220.0" y1="415.0" x2="300.0" y2="405.0" stroke-dasharray="5,5"/>
+  <line stroke="#333333" stroke-width="2" x1="220.86824314212447" y1="421.94594513699565" x2="219.13175685787553" y2="408.05405486300435"/>
+  <circle fill="none" stroke="#333333" stroke-width="2" cx="293.05405486300435" cy="405.86824314212447" r="5.0"/>
+  <line stroke="#333333" stroke-width="2" x1="285.115831849295" y1="406.86052101883814" x2="294.3249410520188" y2="395.0202377581932"/>
+  <line stroke="#333333" stroke-width="2" x1="285.115831849295" y1="406.86052101883814" x2="300.0" y2="405.0"/>
+  <line stroke="#333333" stroke-width="2" x1="285.115831849295" y1="406.86052101883814" x2="296.9561151099399" y2="416.06963022156197"/>
+  <text fill="#000000" x="260.0" y="405.0" text-anchor="middle" font-family="Arial, sans-serif" font-size="11">stores</text>
+</g>
+<g id="entity-CUSTOMER">
+  <rect fill="#f9f9f9" stroke="#333333" stroke-width="2" x="50.0" y="50.0" width="170.0" height="120.0"/>
+  <text fill="#000000" x="135.0" y="76.0" text-anchor="middle" font-family="Arial, sans-serif" font-size="16" font-weight="bold">CUSTOMER</text>
+  <line stroke="#333333" stroke-width="1" x1="50.0" y1="94.0" x2="220.0" y2="94.0"/>
+  <text fill="#000000" x="60.0" y="116.0" font-family="monospace" font-size="12">PK customer_id int</text>
+  <text fill="#000000" x="60.0" y="134.0" font-family="monospace" font-size="12">name string</text>
+  <text fill="#000000" x="60.0" y="152.0" font-family="monospace" font-size="12">UK email string</text>
+  <text fill="#000000" x="60.0" y="170.0" font-family="monospace" font-size="12">phone string</text>
+</g>
+<g id="entity-ORDER">
+  <rect fill="#f9f9f9" stroke="#333333" stroke-width="2" x="300.0" y="50.0" width="170.0" height="140.0"/>
+  <text fill="#000000" x="385.0" y="76.0" text-anchor="middle" font-family="Arial, sans-serif" font-size="16" font-weight="bold">ORDER</text>
+  <line stroke="#333333" stroke-width="1" x1="300.0" y1="94.0" x2="470.0" y2="94.0"/>
+  <text fill="#000000" x="310.0" y="116.0" font-family="monospace" font-size="12">PK order_id int</text>
+  <text fill="#000000" x="310.0" y="134.0" font-family="monospace" font-size="12">FK customer_id int</text>
+  <text fill="#000000" x="310.0" y="152.0" font-family="monospace" font-size="12">order_date date</text>
+  <text fill="#000000" x="310.0" y="170.0" font-family="monospace" font-size="12">total_amount decimal</text>
+  <text fill="#000000" x="310.0" y="188.0" font-family="monospace" font-size="12">status string</text>
+</g>
+<g id="entity-ORDER_ITEM">
+  <rect fill="#f9f9f9" stroke="#333333" stroke-width="2" x="550.0" y="50.0" width="170.0" height="140.0"/>
+  <text fill="#000000" x="635.0" y="76.0" text-anchor="middle" font-family="Arial, sans-serif" font-size="16" font-weight="bold">ORDER_ITEM</text>
+  <line stroke="#333333" stroke-width="1" x1="550.0" y1="94.0" x2="720.0" y2="94.0"/>
+  <text fill="#000000" x="560.0" y="116.0" font-family="monospace" font-size="12">PK order_item_id int</text>
+  <text fill="#000000" x="560.0" y="134.0" font-family="monospace" font-size="12">FK order_id int</text>
+  <text fill="#000000" x="560.0" y="152.0" font-family="monospace" font-size="12">FK product_id int</text>
+  <text fill="#000000" x="560.0" y="170.0" font-family="monospace" font-size="12">quantity int</text>
+  <text fill="#000000" x="560.0" y="188.0" font-family="monospace" font-size="12">unit_price decimal</text>
+</g>
+<g id="entity-PRODUCT">
+  <rect fill="#f9f9f9" stroke="#333333" stroke-width="2" x="50.0" y="250.0" width="170.0" height="140.0"/>
+  <text fill="#000000" x="135.0" y="276.0" text-anchor="middle" font-family="Arial, sans-serif" font-size="16" font-weight="bold">PRODUCT</text>
+  <line stroke="#333333" stroke-width="1" x1="50.0" y1="294.0" x2="220.0" y2="294.0"/>
+  <text fill="#000000" x="60.0" y="316.0" font-family="monospace" font-size="12">PK product_id int</text>
+  <text fill="#000000" x="60.0" y="334.0" font-family="monospace" font-size="12">name string</text>
+  <text fill="#000000" x="60.0" y="352.0" font-family="monospace" font-size="12">UK sku string</text>
+  <text fill="#000000" x="60.0" y="370.0" font-family="monospace" font-size="12">price decimal</text>
+  <text fill="#000000" x="60.0" y="388.0" font-family="monospace" font-size="12">FK category_id int</text>
+</g>
+<g id="entity-INVENTORY">
+  <rect fill="#f9f9f9" stroke="#333333" stroke-width="2" x="300.0" y="250.0" width="170.0" height="140.0"/>
+  <text fill="#000000" x="385.0" y="276.0" text-anchor="middle" font-family="Arial, sans-serif" font-size="16" font-weight="bold">INVENTORY</text>
+  <line stroke="#333333" stroke-width="1" x1="300.0" y1="294.0" x2="470.0" y2="294.0"/>
+  <text fill="#000000" x="310.0" y="316.0" font-family="monospace" font-size="12">PK inventory_id int</text>
+  <text fill="#000000" x="310.0" y="334.0" font-family="monospace" font-size="12">FK product_id int</text>
+  <text fill="#000000" x="310.0" y="352.0" font-family="monospace" font-size="12">FK warehouse_id int</text>
+  <text fill="#000000" x="310.0" y="370.0" font-family="monospace" font-size="12">quantity int</text>
+  <text fill="#000000" x="310.0" y="388.0" font-family="monospace" font-size="12">last_updated date</text>
+</g>
+<g id="entity-CATEGORY">
+  <rect fill="#f9f9f9" stroke="#333333" stroke-width="2" x="550.0" y="250.0" width="170.0" height="100.0"/>
+  <text fill="#000000" x="635.0" y="276.0" text-anchor="middle" font-family="Arial, sans-serif" font-size="16" font-weight="bold">CATEGORY</text>
+  <line stroke="#333333" stroke-width="1" x1="550.0" y1="294.0" x2="720.0" y2="294.0"/>
+  <text fill="#000000" x="560.0" y="316.0" font-family="monospace" font-size="12">PK category_id int</text>
+  <text fill="#000000" x="560.0" y="334.0" font-family="monospace" font-size="12">name string</text>
+  <text fill="#000000" x="560.0" y="352.0" font-family="monospace" font-size="12">description string</text>
+</g>
+<g id="entity-WAREHOUSE">
+  <rect fill="#f9f9f9" stroke="#333333" stroke-width="2" x="50.0" y="450.0" width="170.0" height="100.0"/>
+  <text fill="#000000" x="135.0" y="476.0" text-anchor="middle" font-family="Arial, sans-serif" font-size="16" font-weight="bold">WAREHOUSE</text>
+  <line stroke="#333333" stroke-width="1" x1="50.0" y1="494.0" x2="220.0" y2="494.0"/>
+  <text fill="#000000" x="60.0" y="516.0" font-family="monospace" font-size="12">PK warehouse_id int</text>
+  <text fill="#000000" x="60.0" y="534.0" font-family="monospace" font-size="12">name string</text>
+  <text fill="#000000" x="60.0" y="552.0" font-family="monospace" font-size="12">location string</text>
+</g>
+</svg>

data/examples/er_diagram/README.adoc

@@ -0,0 +1,88 @@
+= Entity-Relationship Diagram Examples
+
+== Purpose
+
+Entity-Relationship (ER) diagrams model database schemas, showing entities (tables), their attributes, and the relationships between them. Essential for database design and documentation.
+
+== When to Use
+
+* Database schema design and documentation
+* Data modeling and normalization
+* System architecture planning
+* Understanding existing database structures
+* Communicating data requirements
+
+== Syntax Overview
+
+[source,mermaid]
+----
+erDiagram
+    CUSTOMER ||--o{ ORDER : places
+    ORDER ||--|{ LINE-ITEM : contains
+    PRODUCT ||--o{ LINE-ITEM : "ordered in"
+----
+
+**Cardinality Notation**:
+- `||--||` - Exactly one
+- `}o--o{` - Zero or more (many)
+- `||--o{` - One to many
+- `}o--||` - Many to one
+
+**Relationship Types**:
+- Identifying relationships (solid line)
+- Non-identifying relationships (dashed line)
+
+== Examples
+
+=== 01: Basic Entities
+
+Demonstrates fundamental ER diagram with simple entities and relationships.
+
+**File**: link:01-basic-entities.mmd[01-basic-entities.mmd]
+
+[source,mermaid]
+----
+include::01-basic-entities.mmd[]
+----
+
+image::01-basic-entities.svg[]
+
+=== 02: Cardinality
+
+Showcases all relationship cardinalities: one-to-one, one-to-many, many-to-many.
+
+**File**: link:02-cardinality.mmd[02-cardinality.mmd]
+
+[source,mermaid]
+----
+include::02-cardinality.mmd[]
+----
+
+image::02-cardinality.svg[]
+
+== Features Demonstrated
+
+[%header,cols="1,1"]
+|===
+| Feature | Example
+
+| Basic entity definition
+| 01, 02
+
+| One-to-many relationships
+| 01, 02
+
+| Many-to-many relationships
+| 02
+
+| Relationship labels
+| 01, 02
+
+| Cardinality notation
+| 02
+|===
+
+== Additional Resources
+
+* link:../../README.adoc[Main Documentation]
+* https://mermaid.js.org/syntax/entityRelationshipDiagram.html[Mermaid ER Diagram Documentation]

data/examples/error/01-basic-error.mmd

@@ -0,0 +1 @@
+Error Diagrams

data/examples/error/01-basic-error.svg

@@ -0,0 +1,13 @@
+<svg
+ width="500.0"
+ height="220.0"
+ viewBox="0 0 500 220"
+ version="1.2"
+ xmlns="http://www.w3.org/2000/svg"
+>
+<rect fill="#FFEBEE" stroke="#D32F2F" stroke-width="2" x="50.0" y="50.0" width="400.0" height="120.0" rx="8.0" ry="8.0"/>
+<circle fill="#D32F2F" stroke="#B71C1C" stroke-width="2" cx="100.0" cy="110.0" r="20.0"/>
+<rect fill="#FFFFFF" x="98.0" y="100.0" width="4.0" height="12.0" rx="2.0"/>
+<circle fill="#FFFFFF" cx="100.0" cy="116.0" r="2.0"/>
+<text fill="#C62828" x="140.0" y="105.0" text-anchor="start" font-family="Arial, Helvetica, sans-serif" font-size="16" font-weight="bold">Diagrams</text>
+</svg>

data/examples/error/02-error-display.mmd

@@ -0,0 +1 @@
+error Critical System Error

data/examples/error/02-error-display.svg

@@ -0,0 +1,13 @@
+<svg
+ width="500.0"
+ height="220.0"
+ viewBox="0 0 500 220"
+ version="1.2"
+ xmlns="http://www.w3.org/2000/svg"
+>
+<rect fill="#FFEBEE" stroke="#D32F2F" stroke-width="2" x="50.0" y="50.0" width="400.0" height="120.0" rx="8.0" ry="8.0"/>
+<circle fill="#D32F2F" stroke="#B71C1C" stroke-width="2" cx="100.0" cy="110.0" r="20.0"/>
+<rect fill="#FFFFFF" x="98.0" y="100.0" width="4.0" height="12.0" rx="2.0"/>
+<circle fill="#FFFFFF" cx="100.0" cy="116.0" r="2.0"/>
+<text fill="#C62828" x="140.0" y="105.0" text-anchor="start" font-family="Arial, Helvetica, sans-serif" font-size="16" font-weight="bold">Critical System Error</text>
+</svg>