Get-GitHubMarkdownRaw¶

SYNOPSIS¶

Render a Markdown document in raw mode

SYNTAX¶

Get-GitHubMarkdownRaw [[-Text] <String>] [[-Context] <Object>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION¶

You must send Markdown as plain text (using a Content-Type header of text/plain or text/x-markdown) to this endpoint, rather than using JSON format. In raw mode, GitHub Flavored Markdown is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.

EXAMPLES¶

EXAMPLE 1¶

Get-GitHubMarkdownRaw -Text 'Hello, world!'
"<p>Hello <strong>world</strong></p>"

Render the Markdown text 'Hello, world!' in raw mode.

PARAMETERS¶

-Text¶

The Markdown text to render in HTML.

Type: String
Parameter Sets: (All)
Aliases:

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

-Context¶

The context to run the command in. Used to get the details for the API call. Can be either a string or a GitHubContext object.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: (Get-GitHubContext)
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction¶

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¶