Mermaid (yog-fsharp)

Mermaid Module

Namespace: Yog.IO
Assembly: Yog.FSharp.dll

Mermaid diagram rendering.

Provides functions to export graphs in Mermaid syntax for embedding in markdown documents.

Example

 1: 
 2: 
 3: 
 4: 
 5: 
 6: 
 7: 
 8: 
 9: 
10: 
11:

open Yog.IO
open Yog.Model

let graph =
    empty Directed
    |> addNode 1 "Start"
    |> addNode 2 "End"
    |> addEdge 1 2 5

// Export to Mermaid for markdown
let mermaid = Mermaid.render Mermaid.defaultOptions graph

namespace Yog

namespace Yog.IO

module Model from Yog
<summary> Core graph data structures and basic operations for the yog library. This module defines the fundamental `Graph` type and provides all basic operations for creating and manipulating graphs. The graph uses an adjacency list representation with dual indexing (both outgoing and incoming edges) for efficient traversal in both directions. </summary>

val graph: Graph<string,int>

val empty: graphType: GraphType -> Graph<'n,'e>
<summary> Creates a new empty graph of the specified type. ## Example let graph = Model.empty Directed ## Parameters - `graphType`: The type of the graph. ## Returns A new empty graph. </summary>

union case GraphType.Directed: GraphType
<summary> A directed graph where edges have a direction from source to destination. </summary>

val addNode: id: NodeId -> data: 'n -> graph: Graph<'n,'e> -> Graph<'n,'e>
<summary> Adds a node to the graph with the given ID and data. If a node with this ID already exists, its data will be replaced. ## Example graph |> addNode 1 "Node A" |> addNode 2 "Node B" ## Parameters - `id`: The unique identifier for the node. - `data`: The data to store at the node. - `graph`: The graph to add the node to. ## Returns A new graph with the node added. </summary>

val addEdge: src: NodeId -> dst: NodeId -> weight: 'e -> graph: Graph<'n,'e> -> Graph<'n,'e>
<summary> Adds an edge to the graph with the given weight. For directed graphs, adds a single edge from src to dst. For undirected graphs, adds edges in both directions. ## Example graph |> addEdge 1 2 10 **Note:** If `src` or `dst` have not been added via `addNode`, an `ArgumentException` is thrown. To automatically create missing endpoints when adding an edge, use `addEdgeEnsured` or `addEdgeEnsuredWith`. ## Parameters - `src`: The source node ID. - `dst`: The destination node ID. - `weight`: The weight of the edge. - `graph`: The graph to add the edge to. ## Returns A new graph with the edge added. </summary>

val mermaid: string

module Mermaid from Yog.IO
<summary> Mermaid diagram rendering. Provides functions to export graphs in Mermaid syntax for embedding in markdown documents. ## Example open Yog.IO open Yog.Model let graph = empty Directed |> addNode 1 "Start" |> addNode 2 "End" |> addEdge 1 2 5 // Export to Mermaid for markdown let mermaid = Mermaid.render Mermaid.defaultOptions graph </summary>

val render: options: Mermaid.Options<'n,'e> -> graph: Graph<'n,'e> -> string
<summary> Converts a graph to Mermaid diagram syntax. Mermaid diagrams can be embedded directly in markdown and rendered by many documentation tools (GitHub, GitLab, Notion, etc.). **Time Complexity:** O(V + E) ## Example let graph = empty Directed |> addNode 1 "Start" |> addNode 2 "Process" |> addNode 3 "End" |> addEdge 1 2 5 |> addEdge 2 3 3 // Highlight a path let options = { Mermaid.defaultOptions with HighlightedNodes = Set.ofList [1; 2; 3] HighlightedEdges = Set.ofList [(1, 2); (2, 3)] } let diagram = Mermaid.render options graph // graph TD // classDef highlight fill:#ffeb3b,stroke:#f57c00,stroke-width:3px // 1["Start"]:::highlight // 2["Process"]:::highlight // 3["End"]:::highlight // 1 -->|"5"| 2:::highlightEdge // 2 -->|"3"| 3:::highlightEdge ## Use Cases - Documentation and README files - Wiki pages - Presentation slides - Quick prototyping and sharing </summary>

val defaultOptions<'n,'e> : Mermaid.Options<'n,'e>
<summary> Default configuration for Mermaid output. Uses node ID as a label and edge weight as a string. </summary>

Types

Type	Description
Options<'n, 'e>	Options for customizing Mermaid diagram rendering.

Functions and values

Function or value Description


                
                  
                    
                      defaultOptions

Full Usage: defaultOptions

Returns: Options<'n, 'e>

Default configuration for Mermaid output.

Uses node ID as a label and edge weight as a string.

Returns: Options<'n, 'e>


                
                  
                    
                      render options graph

Full Usage: render options graph

Parameters:

options : Options<'n, 'e>

graph : Graph<'n, 'e>

Returns: string

Converts a graph to Mermaid diagram syntax.

Mermaid diagrams can be embedded directly in markdown and rendered by many documentation tools (GitHub, GitLab, Notion, etc.).

Time Complexity: O(V + E)

Example

 1: 
 2: 
 3: 
 4: 
 5: 
 6: 
 7: 
 8: 
 9: 
10: 
11: 
12: 
13: 
14: 
15: 
16: 
17: 
18: 
19: 
20: 
21: 
22:

let graph =
    empty Directed
    |> addNode 1 "Start"
    |> addNode 2 "Process"
    |> addNode 3 "End"
    |> addEdge 1 2 5
    |> addEdge 2 3 3

// Highlight a path
let options = { Mermaid.defaultOptions with
    HighlightedNodes = Set.ofList [1; 2; 3]
    HighlightedEdges = Set.ofList [(1, 2); (2, 3)]
}

let diagram = Mermaid.render options graph
// graph TD
//   classDef highlight fill:#ffeb3b,stroke:#f57c00,stroke-width:3px
//   1["Start"]:::highlight
//   2["Process"]:::highlight
//   3["End"]:::highlight
//   1 -->|"5"| 2:::highlightEdge
//   2 -->|"3"| 3:::highlightEdge

Use Cases

Documentation and README files
Wiki pages
Presentation slides
Quick prototyping and sharing

val graph: obj

val options: bool

Multiple items
module Set from Microsoft.FSharp.Collections

--------------------
type Set<'T (requires comparison)> = interface IReadOnlyCollection<'T> interface IStructuralEquatable interface IComparable interface IEnumerable interface IEnumerable<'T> interface ICollection<'T> new: elements: 'T seq -> Set<'T> member Add: value: 'T -> Set<'T> member Contains: value: 'T -> bool override Equals: objnull -> bool ...

--------------------
new: elements: 'T seq -> Set<'T>

val ofList: elements: 'T list -> Set<'T> (requires comparison)

val diagram: obj

options : Options<'n, 'e>
graph : Graph<'n, 'e>

Returns: string


                
                  
                    
                      writeFile path options graph

Full Usage: writeFile path options graph

Parameters:

path : string

options : Options<'n, 'e>

graph : Graph<'n, 'e>

Renders a graph to a Mermaid file.

Example

1: 
2: 
3: 
4: 
5: 
6: 
7:

let graph =
    empty Directed
    |> addNode 1 "A"
    |> addNode 2 "B"
    |> addEdge 1 2 5

Mermaid.writeFile "output.mmd" Mermaid.defaultOptions graph

val graph: obj

path : string
options : Options<'n, 'e>
graph : Graph<'n, 'e>