Converts arbitrary Markdown into HTML.

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

Converts arbitrary Markdown into HTML.

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

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

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

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

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

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

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

If this switch is specified, long-running commands will run on the main thread with no commandline status update. When not specified, those commands run in the background, enabling the command prompt to provide status information. If not supplied here, the DefaultNoStatus configuration property value will be used.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

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

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.