Get-GitHubMarkdown¶
SYNOPSIS¶
Render a Markdown document
SYNTAX¶
Get-GitHubMarkdown [-Text] <String> [[-Mode] <String>] [[-RepoContext] <String>] [[-Context] <Object>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION¶
Converts Markdown to HTML
EXAMPLES¶
EXAMPLE 1¶
Get-GitHubMarkdown -Text "Hello **world**"
"<p>Hello <strong>world</strong></p>"
Renders the Markdown text "Hello world" to HTML.
PARAMETERS¶
-Text¶
The Markdown text to render in HTML.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Mode¶
The rendering mode.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: Markdown
Accept pipeline input: False
Accept wildcard characters: False
-RepoContext¶
The repository context to use when creating references in gfm mode.
For example, setting context to octo-org/octo-repo will change the
text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
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: 4
Default value: (Get-GitHubContext)
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.