ConvertFrom GitHubMarkdown

ConvertFrom-GitHubMarkdown

SYNOPSIS

Converts arbitrary Markdown into HTML.

SYNTAX

ConvertFrom-GitHubMarkdown [-Content] <String> [[-Mode] <String>] [[-Context] <String>]
 [[-AccessToken] <String>] [<CommonParameters>]

DESCRIPTION

Converts arbitrary Markdown into HTML.

The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub

EXAMPLES

EXAMPLE 1

ConvertFrom-GitHubMarkdown -Content '**Bolded Text**' -Mode Markdown

Returns back '<p><strong>Bolded Text</strong></p>'

PARAMETERS

-AccessToken

If provided, this will be used as the AccessToken for authentication with the REST Api. Otherwise, will attempt to use the configured value or will run unauthenticated.

Type: System.String
Parameter Sets: (All)
Aliases:

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

-Content

The Markdown text to render to HTML. Content must be 400 KB or less.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Context

The repository to use when creating references in 'githubFlavoredMarkdown' mode. Specify as [ownerName]/[repositoryName].

Type: System.String
Parameter Sets: (All)
Aliases:

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

-Mode

The rendering mode for the Markdown content.

Markdown - Renders Content in plain Markdown, just like README.md files are rendered

GitHubFlavoredMarkdown - Creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: Markdown
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

[String]

OUTPUTS

[String] The HTML version of the Markdown content.

NOTES

RELATED LINKS