Cmdlet

Get-OfficeMarkdownHeading

Module: PSWriteOffice
Inputs: OfficeIMO.Markdown.MarkdownDoc
Outputs: OfficeIMO.Markdown.MarkdownDoc+HeadingInfo
Source: GetOfficeMarkdownHeadingCommand.cs:23 Edit on GitHub

Gets heading metadata from a Markdown document.

Syntax

Get-OfficeMarkdownHeading
[-AllowDataUrls <Boolean>]
[-AllowedUrlScheme <String[]>]
[-AllowMailtoUrls <Boolean>]
[-AllowProtocolRelativeUrls <Boolean>]
[-Anchor <String>]
[-BaseUri <String>]
[-CaseSensitive]
[-DisallowFileUrls <Boolean>]
[-HeadingText <String>]
[-MaxInputCharacters <Int32>]
[-MaxLevel <Int32>]
[-MinLevel <Int32>]
[-NormalizeInput <IntelligenceXTranscript|IntelligenceXTranscriptStrict|DocsLoose>]
[-Options <MarkdownReaderOptions>]
[-Path] <String>
[-Profile <OfficeIMO|CommonMark|GitHubFlavoredMarkdown|Portable>]
[-RestrictUrlSchemes <Boolean>]
[<CommonParameters>]

Parameter set: Path

Get-OfficeMarkdownHeading
[-AllowDataUrls <Boolean>]
[-AllowedUrlScheme <String[]>]
[-AllowMailtoUrls <Boolean>]
[-AllowProtocolRelativeUrls <Boolean>]
[-Anchor <String>]
[-BaseUri <String>]
[-CaseSensitive]
[-DisallowFileUrls <Boolean>]
-Document <MarkdownDoc>
[-HeadingText <String>]
[-MaxInputCharacters <Int32>]
[-MaxLevel <Int32>]
[-MinLevel <Int32>]
[-NormalizeInput <IntelligenceXTranscript|IntelligenceXTranscriptStrict|DocsLoose>]
[-Options <MarkdownReaderOptions>]
[-Profile <OfficeIMO|CommonMark|GitHubFlavoredMarkdown|Portable>]
[-RestrictUrlSchemes <Boolean>]
[<CommonParameters>]

Parameter set: Document

Get-OfficeMarkdownHeading
[-AllowDataUrls <Boolean>]
[-AllowedUrlScheme <String[]>]
[-AllowMailtoUrls <Boolean>]
[-AllowProtocolRelativeUrls <Boolean>]
[-Anchor <String>]
[-BaseUri <String>]
[-CaseSensitive]
[-DisallowFileUrls <Boolean>]
[-HeadingText <String>]
[-MaxInputCharacters <Int32>]
[-MaxLevel <Int32>]
[-MinLevel <Int32>]
[-NormalizeInput <IntelligenceXTranscript|IntelligenceXTranscriptStrict|DocsLoose>]
[-Options <MarkdownReaderOptions>]
[-Profile <OfficeIMO|CommonMark|GitHubFlavoredMarkdown|Portable>]
[-RestrictUrlSchemes <Boolean>]
-Text <String>
[<CommonParameters>]

Parameter set: Text

Description

Returns heading level, text, resolved anchor, and the backing heading block.

Examples

Read headings from Markdown text.

Get-OfficeMarkdownHeading -Text "# Title`n`n## Details"

Parses Markdown text and returns the document headings.

Inspect a parsed Markdown document.

Get-OfficeMarkdown -Path .\README.md | Get-OfficeMarkdownHeading -MinLevel 2

Returns headings from an existing Markdown document object.

Parameters

-AllowDataUrls Boolean optional: Allow data URLs while parsing Markdown links and images.
-AllowedUrlScheme String[] optional: Allowed URL schemes when URL scheme restriction is enabled.
-AllowMailtoUrls Boolean optional: Allow mailto URLs while parsing Markdown links.
-AllowProtocolRelativeUrls Boolean optional: Allow protocol-relative URLs while parsing Markdown links and images.
-Anchor String optional: Optional wildcard pattern matched against resolved heading anchors.
-BaseUri String optional: Base URI used to resolve and restrict relative Markdown links and images.
-CaseSensitive SwitchParameter optional: Use case-sensitive matching for text and anchor filters.
-DisallowFileUrls Boolean optional: Block file URLs while parsing Markdown links and images.
-HeadingText String optional: Optional wildcard pattern matched against heading text.
-MaxInputCharacters Int32 optional: Maximum Markdown input length accepted by the reader.
-MaxLevel Int32 optional: Maximum heading level to return.
-MinLevel Int32 optional: Minimum heading level to return.
-NormalizeInput MarkdownInputNormalizationPreset optional: Applies a built-in Markdown input normalization preset before parsing.; Possible values: IntelligenceXTranscript, IntelligenceXTranscriptStrict, DocsLoose
-Options MarkdownReaderOptions optionalaliases: ReaderOptions: Optional reader options used when parsing path or text input.
-Path String requiredposition: 0aliases: FilePath, InputPathsets: Path: Path to the Markdown file.
-Profile MarkdownDialectProfile optional: Named reader profile used when Options is not supplied.; Possible values: OfficeIMO, CommonMark, GitHubFlavoredMarkdown, Portable
-RestrictUrlSchemes Boolean optional: Restrict parsed URL schemes to the allow-list.
-Document MarkdownDoc requiredpipeline: True (ByValue)sets: Document: Markdown document to inspect.
-Text String requiredsets: Text: Markdown text to parse.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.