API Reference
Cmdlet
Get-OfficeMarkdown
Parses Markdown text or files into a Markdown document model.
Remarks
Returns an MarkdownDoc for inspection or further rendering.
Examples
Example 1: Parse a Markdown file.
PS>
$md = Get-OfficeMarkdown -Path .\README.md
Loads the file into a Markdown document object.
Example 2: Parse Markdown text in-memory.
PS>
$md = Get-OfficeMarkdown -Text '# Title`n`nBody text'
Parses Markdown text directly into a document model.
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.
Syntax
Get-OfficeMarkdown [-AllowDataUrls <Nullable`1>] [-AllowedUrlScheme <String[]>] [-AllowMailtoUrls <Nullable`1>] [-AllowProtocolRelativeUrls <Nullable`1>] [-BaseUri <String>] [-DisallowFileUrls <Nullable`1>] -InputPath <String> [-MaxInputCharacters <Nullable`1>] [-NormalizeInput <Nullable`1>] [-Options <MarkdownReaderOptions>] [-Profile <Nullable`1>] [-RestrictUrlSchemes <Nullable`1>] [<CommonParameters>]Parameter set:
PathParameters
- AllowDataUrls Nullable`1
- Allow data URLs while parsing Markdown links and images.
- AllowedUrlScheme String[]
- Allowed URL schemes when URL scheme restriction is enabled.
- AllowMailtoUrls Nullable`1
- Allow mailto URLs while parsing Markdown links.
- AllowProtocolRelativeUrls Nullable`1
- Allow protocol-relative URLs while parsing Markdown links and images.
- BaseUri String
- Base URI used to resolve and restrict relative Markdown links and images.
- DisallowFileUrls Nullable`1
- Block file URLs while parsing Markdown links and images.
- InputPath String
- Path to the Markdown file.
- MaxInputCharacters Nullable`1
- Maximum Markdown input length accepted by the reader.
- NormalizeInput Nullable`1
- Applies a built-in Markdown input normalization preset before parsing. Possible values: None, IntelligenceXTranscript, IntelligenceXTranscriptStrict, DocsLoose
- Options MarkdownReaderOptions
- Optional reader options.
- Profile Nullable`1
- Named reader profile used when Options is not supplied. Possible values: OfficeIMO, CommonMark, GitHubFlavoredMarkdown, Portable
- RestrictUrlSchemes Nullable`1
- Restrict parsed URL schemes to the allow-list.
Outputs
OfficeIMO.Markdown.MarkdownDoc
Get-OfficeMarkdown [-AllowDataUrls <Nullable`1>] [-AllowedUrlScheme <String[]>] [-AllowMailtoUrls <Nullable`1>] [-AllowProtocolRelativeUrls <Nullable`1>] [-BaseUri <String>] [-DisallowFileUrls <Nullable`1>] [-MaxInputCharacters <Nullable`1>] [-NormalizeInput <Nullable`1>] [-Options <MarkdownReaderOptions>] [-Profile <Nullable`1>] [-RestrictUrlSchemes <Nullable`1>] -Text <String> [<CommonParameters>]Parameter set:
TextParameters
- AllowDataUrls Nullable`1
- Allow data URLs while parsing Markdown links and images.
- AllowedUrlScheme String[]
- Allowed URL schemes when URL scheme restriction is enabled.
- AllowMailtoUrls Nullable`1
- Allow mailto URLs while parsing Markdown links.
- AllowProtocolRelativeUrls Nullable`1
- Allow protocol-relative URLs while parsing Markdown links and images.
- BaseUri String
- Base URI used to resolve and restrict relative Markdown links and images.
- DisallowFileUrls Nullable`1
- Block file URLs while parsing Markdown links and images.
- MaxInputCharacters Nullable`1
- Maximum Markdown input length accepted by the reader.
- NormalizeInput Nullable`1
- Applies a built-in Markdown input normalization preset before parsing. Possible values: None, IntelligenceXTranscript, IntelligenceXTranscriptStrict, DocsLoose
- Options MarkdownReaderOptions
- Optional reader options.
- Profile Nullable`1
- Named reader profile used when Options is not supplied. Possible values: OfficeIMO, CommonMark, GitHubFlavoredMarkdown, Portable
- RestrictUrlSchemes Nullable`1
- Restrict parsed URL schemes to the allow-list.
- Text String
- Markdown text to parse.
Outputs
OfficeIMO.Markdown.MarkdownDoc