Skip to content

Write-PodeMarkdownResponse

SYNOPSIS

Writes Markdown data to the Response.

SYNTAX

Value (Default)

Write-PodeMarkdownResponse -Value <Object> [-StatusCode <Int32>] [-AsHtml] [<CommonParameters>]

File

Write-PodeMarkdownResponse -Path <String> [-StatusCode <Int32>] [-AsHtml] [<CommonParameters>]

DESCRIPTION

Writes Markdown data to the Response, with the option to render it as HTML.

EXAMPLES

EXAMPLE 1

Write-PodeMarkdownResponse -Value '# Hello, world!' -AsHtml

EXAMPLE 2

Write-PodeMarkdownResponse -Path 'E:/Site/About.md'

PARAMETERS

-AsHtml

If supplied, the Markdown will be converted to HTML. (This is only supported in PS7+)

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Path

The path to a Markdown file.

Type: String
Parameter Sets: File
Aliases:

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

-StatusCode

The status code to set against the response.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Value

A String, PSObject, or HashTable value.

Type: Object
Parameter Sets: Value
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
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