Export-HtmlOutline

August 3, 2026 ยท View on GitHub

SYNOPSIS

Exports a hierarchical outline of headings in HTML content to a JSON file.

SYNTAX

Content (Default)

Export-HtmlOutline [-Content] <string> [-Path] <string> [-Engine <HtmlParserEngine>] [-Proxy <string>] [-ProxyCredential <pscredential>] [<CommonParameters>]

Url

Export-HtmlOutline [-Url] <uri> [-Path] <string> [-Engine <HtmlParserEngine>] [-Proxy <string>] [-ProxyCredential <pscredential>] [<CommonParameters>]

DESCRIPTION

Exports a hierarchical outline of headings in HTML content to a JSON file.

EXAMPLES

EXAMPLE 1

Export-HTMLOutline -Url https://example.com -Path outline.json

PARAMETERS

-Content

HTML markup to analyze.

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

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

-Engine

Parsing engine used for processing HTML.

Type: HtmlParserEngine
Parameter Sets: Content, Url
Aliases: None
Possible values: AngleSharp, AgilityPack

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

-Path

Destination path for the JSON outline.

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

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

-Proxy

Proxy server address used when Url is specified.

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

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

-ProxyCredential

Credentials used with the specified Proxy.

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

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

-Url

URL of the page to analyze.

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

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

  • None
  • None