Cmdlet
Get-OfficeMarkdownNode
Gets the OfficeIMO.Markdown object tree from Markdown content.
Syntax
Get-OfficeMarkdownNode
[-AllowDataUrls <Boolean>]
[-AllowedUrlScheme <String[]>]
[-AllowMailtoUrls <Boolean>]
[-AllowProtocolRelativeUrls <Boolean>]
[-BaseUri <String>]
[-CaseSensitive]
[-DisallowFileUrls <Boolean>]
[-MaxDepth <Int32>]
[-MaxInputCharacters <Int32>]
[-NodeType <String>]
[-NormalizeInput <IntelligenceXTranscript| IntelligenceXTranscriptStrict| DocsLoose>]
[-Options <MarkdownReaderOptions>]
[-Path] <String>
[-Profile <OfficeIMO| CommonMark| GitHubFlavoredMarkdown| Portable>]
[-Raw]
[-RestrictUrlSchemes <Boolean>]
[<CommonParameters>]#Parameter set:
PathGet-OfficeMarkdownNode
[-AllowDataUrls <Boolean>]
[-AllowedUrlScheme <String[]>]
[-AllowMailtoUrls <Boolean>]
[-AllowProtocolRelativeUrls <Boolean>]
[-BaseUri <String>]
[-CaseSensitive]
[-DisallowFileUrls <Boolean>]
-Document <MarkdownDoc>
[-MaxDepth <Int32>]
[-MaxInputCharacters <Int32>]
[-NodeType <String>]
[-NormalizeInput <IntelligenceXTranscript| IntelligenceXTranscriptStrict| DocsLoose>]
[-Options <MarkdownReaderOptions>]
[-Profile <OfficeIMO| CommonMark| GitHubFlavoredMarkdown| Portable>]
[-Raw]
[-RestrictUrlSchemes <Boolean>]
[<CommonParameters>]#Parameter set:
DocumentGet-OfficeMarkdownNode
[-AllowDataUrls <Boolean>]
[-AllowedUrlScheme <String[]>]
[-AllowMailtoUrls <Boolean>]
[-AllowProtocolRelativeUrls <Boolean>]
[-BaseUri <String>]
[-CaseSensitive]
[-DisallowFileUrls <Boolean>]
[-MaxDepth <Int32>]
[-MaxInputCharacters <Int32>]
[-NodeType <String>]
[-NormalizeInput <IntelligenceXTranscript| IntelligenceXTranscriptStrict| DocsLoose>]
[-Options <MarkdownReaderOptions>]
[-Profile <OfficeIMO| CommonMark| GitHubFlavoredMarkdown| Portable>]
[-Raw]
[-RestrictUrlSchemes <Boolean>]
-Text <String>
[<CommonParameters>]#Parameter set:
TextDescription
Returns PowerShell-friendly node records by default. Use -Raw to emit the underlying OfficeIMO nodes.
Examples
Inspect the Markdown object tree.
Get-OfficeMarkdownNode -Text "# Report`n`n## Summary"Parses Markdown text and returns the document, block, and inline object tree.
Inspect a parsed document.
Get-OfficeMarkdown -Path .\README.md | Get-OfficeMarkdownNode -NodeType '*Table*'Returns matching nodes from an existing Markdown document.
Parameters
- -AllowDataUrls Boolean
- Allow data URLs while parsing Markdown links and images.
- -AllowedUrlScheme String[]
- Allowed URL schemes when URL scheme restriction is enabled.
- -AllowMailtoUrls Boolean
- Allow mailto URLs while parsing Markdown links.
- -AllowProtocolRelativeUrls Boolean
- Allow protocol-relative URLs while parsing Markdown links and images.
- -BaseUri String
- Base URI used to resolve and restrict relative Markdown links and images.
- -CaseSensitive SwitchParameter
- Use case-sensitive matching for node type filters.
- -DisallowFileUrls Boolean
- Block file URLs while parsing Markdown links and images.
- -MaxDepth Int32
- Maximum traversal depth. Zero returns only the document root.
- -MaxInputCharacters Int32
- Maximum Markdown input length accepted by the reader.
- -NodeType String
- Optional wildcard pattern matched against node type names.
- -NormalizeInput MarkdownInputNormalizationPreset
- Applies a built-in Markdown input normalization preset before parsing.
- Possible values:
IntelligenceXTranscript,IntelligenceXTranscriptStrict,DocsLoose - -Options MarkdownReaderOptions
- Optional reader options used when parsing path or text input.
- -Path String
- Path to the Markdown file.
- -Profile MarkdownDialectProfile
- Named reader profile used when Options is not supplied.
- Possible values:
OfficeIMO,CommonMark,GitHubFlavoredMarkdown,Portable - -Raw SwitchParameter
- Emit raw OfficeIMO.Markdown node objects instead of PowerShell-friendly records.
- -RestrictUrlSchemes Boolean
- Restrict parsed URL schemes to the allow-list.
- -Document MarkdownDoc
- Markdown document to inspect.
- -Text String
- 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.