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
Parse a Markdown file.
PS>
$md = Get-OfficeMarkdown -Path .\README.md
Loads the file into a Markdown document object.
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 <Boolean>] [-AllowedUrlScheme <String[]>] [-AllowMailtoUrls <Boolean>] [-AllowProtocolRelativeUrls <Boolean>] [-BaseUri <String>] [-DisallowFileUrls <Boolean>] [-MaxInputCharacters <Int32>] [-NormalizeInput <IntelligenceXTranscript|IntelligenceXTranscriptStrict|DocsLoose>] [-Options <MarkdownReaderOptions>] -Path <String> [-Profile <OfficeIMO|CommonMark|GitHubFlavoredMarkdown|Portable>] [-RestrictUrlSchemes <Boolean>] [<CommonParameters>]Parameter set:
PathParameters
- 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.
- DisallowFileUrls Boolean
- Block file URLs while parsing Markdown links and images.
- MaxInputCharacters Int32
- Maximum Markdown input length accepted by the reader.
- NormalizeInput MarkdownInputNormalizationPreset
- Applies a built-in Markdown input normalization preset before parsing.
- Possible values:
IntelligenceXTranscript,IntelligenceXTranscriptStrict,DocsLoose - Options MarkdownReaderOptions
- Optional reader options.
- Path String
- Path to the Markdown file.
- Profile MarkdownDialectProfile
- Named reader profile used when Options is not supplied.
- Possible values:
OfficeIMO,CommonMark,GitHubFlavoredMarkdown,Portable - RestrictUrlSchemes Boolean
- Restrict parsed URL schemes to the allow-list.
Outputs
OfficeIMO.Markdown.MarkdownDoc
Get-OfficeMarkdown [-AllowDataUrls <Boolean>] [-AllowedUrlScheme <String[]>] [-AllowMailtoUrls <Boolean>] [-AllowProtocolRelativeUrls <Boolean>] [-BaseUri <String>] [-DisallowFileUrls <Boolean>] [-MaxInputCharacters <Int32>] [-NormalizeInput <IntelligenceXTranscript|IntelligenceXTranscriptStrict|DocsLoose>] [-Options <MarkdownReaderOptions>] [-Profile <OfficeIMO|CommonMark|GitHubFlavoredMarkdown|Portable>] [-RestrictUrlSchemes <Boolean>] -Text <String> [<CommonParameters>]Parameter set:
TextParameters
- 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.
- DisallowFileUrls Boolean
- Block file URLs while parsing Markdown links and images.
- MaxInputCharacters Int32
- Maximum Markdown input length accepted by the reader.
- NormalizeInput MarkdownInputNormalizationPreset
- Applies a built-in Markdown input normalization preset before parsing.
- Possible values:
IntelligenceXTranscript,IntelligenceXTranscriptStrict,DocsLoose - Options MarkdownReaderOptions
- Optional reader options.
- Profile MarkdownDialectProfile
- Named reader profile used when Options is not supplied.
- Possible values:
OfficeIMO,CommonMark,GitHubFlavoredMarkdown,Portable - RestrictUrlSchemes Boolean
- Restrict parsed URL schemes to the allow-list.
- Text String
- Markdown text to parse.
Outputs
OfficeIMO.Markdown.MarkdownDoc