Convert-HtmlToMarkdown

August 3, 2026 ยท View on GitHub

SYNOPSIS

Converts HTML content to Markdown.

SYNTAX

Content (Default)

Convert-HtmlToMarkdown -Content <string> [-PageUrl <string>] [-OutputFile <string>] [-MarkdownProfile <HtmlMarkdownProfile>] [-MarkdownImageMode <MarkdownImageRenderingMode>] [-ListingCardMetadataMode <HtmlListingCardMetadataMode>] [-Proxy <string>] [-ProxyCredential <pscredential>] [<CommonParameters>]

File

Convert-HtmlToMarkdown -Path <string> [-PageUrl <string>] [-OutputFile <string>] [-MarkdownProfile <HtmlMarkdownProfile>] [-MarkdownImageMode <MarkdownImageRenderingMode>] [-ListingCardMetadataMode <HtmlListingCardMetadataMode>] [-Proxy <string>] [-ProxyCredential <pscredential>] [<CommonParameters>]

Url

Convert-HtmlToMarkdown -Url <uri> [-PageUrl <string>] [-OutputFile <string>] [-MarkdownProfile <HtmlMarkdownProfile>] [-MarkdownImageMode <MarkdownImageRenderingMode>] [-ListingCardMetadataMode <HtmlListingCardMetadataMode>] [-Proxy <string>] [-ProxyCredential <pscredential>] [<CommonParameters>]

DESCRIPTION

You can provide raw HTML, a local file, or download a page with -Url. When downloading, optional -Proxy and -ProxyCredential can be used.

EXAMPLES

EXAMPLE 1

Convert-HtmlToMarkdown -Content "<h1>Hello</h1>"

EXAMPLE 2

Convert-HtmlToMarkdown -Url https://example.com -Proxy http://proxy:8080

PARAMETERS

-Content

HTML content to convert.

Type: String
Parameter Sets: Content
Aliases: None
Possible values:

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

-ListingCardMetadataMode

Controls whether low-value metadata inside repeated listing cards should be preserved or suppressed.

Type: HtmlListingCardMetadataMode
Parameter Sets: Content, File, Url
Aliases: None
Possible values: Preserve, SuppressInRepeatedCards

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

-MarkdownImageMode

Controls how images are emitted in Markdown.

Type: MarkdownImageRenderingMode
Parameter Sets: Content, File, Url
Aliases: None
Possible values: RichMarkdown, PortableMarkdown, Html

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

-MarkdownProfile

Controls which Markdown dialect profile is used.

Type: HtmlMarkdownProfile
Parameter Sets: Content, File, Url
Aliases: None
Possible values: Portable, OfficeIMO

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

-OutputFile

Optional path to write the resulting Markdown.

Type: String
Parameter Sets: Content, File, Url
Aliases: None
Possible values:

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

-PageUrl

Optional absolute page URL used to resolve relative links and images.

Type: String
Parameter Sets: Content, File, Url
Aliases: None
Possible values:

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

-Path

Path to a HTML file.

Type: String
Parameter Sets: File
Aliases: File
Possible values:

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

-Proxy

Proxy server address used when downloading from Url. Include the protocol and port if necessary.

Type: String
Parameter Sets: Content, File, Url
Aliases: None
Possible values:

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

-ProxyCredential

Credentials used for the Proxy server.

Type: PSCredential
Parameter Sets: Content, File, Url
Aliases: None
Possible values:

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

-Url

URL of a HTML page to download and convert.

Type: Uri
Parameter Sets: Url
Aliases: Uri
Possible values:

Required: True
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

  • System.String

OUTPUTS

  • System.String
  • None