Skip to main content
Version: 2.0.0

Get-MtSafeMarkdown

SYNOPSIS

Escapes text to be safe to use in markdown.

SYNTAX

Get-MtSafeMarkdown [[-Text] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Escapes text to be safe to use in markdown.

EXAMPLES

EXAMPLE 1

Get-MtSafeMarkdown -Text $tenantName

Converts the content of $tenantName into something safe to use in markdown.

PARAMETERS

-Text

The text to escape

Type: String
Parameter Sets: (All)
Aliases:

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

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

OUTPUTS

NOTES

https://maester.dev/docs/commands/Get-MtSafeMarkdown