PsMermaidTools

PowerShell Module to create Mermaid diagrams.

View the Project on GitHub abbgrade/PsMermaidTools

New-MermaidDiagram

SYNOPSIS

Creates a new mermaid diagram.

SYNTAX

erDiagram (Default)

New-MermaidDiagram [-ErDiagram] [-Title <String>] [<CommonParameters>]

flowchart

New-MermaidDiagram [-Flowchart] [[-Orientation] <String>] [-Title <String>] [<CommonParameters>]

C4Component

New-MermaidDiagram [-C4Component] [<CommonParameters>]

DESCRIPTION

Creates and returns a new diagram definition, that can be populated and later exported.

EXAMPLES

EXAMPLE 1

$diagram = New-MermaidDiagram -ErDiagram
PS C:\> $diagram | Add-MermaidErRelation Exactly-one Customer places Zero-or-more Order
PS C:\> $diagram | Add-MermaidErRelation Exactly-one Order contains One-or-more LineItem
PS C:\> $diagram | Add-MermaidErRelation One-or-more Customer uses One-or-more DeliveryAddress -NonIdentifying
PS C:\> $diagram | ConvertTo-MermaidString
erDiagram
    Customer ||--o{ Order : places
    Order ||--|{ LineItem : contains
    Customer }|..|{ DeliveryAddress : uses

Create a erDiagram, add a few relations and convert it to a diagram string.

PARAMETERS

-Flowchart

The mermaid diagram type.

Type: SwitchParameter
Parameter Sets: flowchart
Aliases:

Required: True
Position: 1
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ErDiagram

Type: SwitchParameter
Parameter Sets: erDiagram
Aliases:

Required: True
Position: 1
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-C4Component

Type: SwitchParameter
Parameter Sets: C4Component
Aliases:

Required: True
Position: 1
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Orientation

The diagram orientation.

Type: String
Parameter Sets: flowchart
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Title

The diagram title.

Type: String
Parameter Sets: erDiagram, flowchart
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None.

OUTPUTS

Mermaid diagram definition object.

NOTES

https://mermaid-js.github.io/mermaid/#/README?id=diagram-types