API Reference
Cmdlet
Get-OfficeMarkdownFrontMatter
Gets YAML front matter entries from a Markdown document.
Remarks
Gets YAML front matter entries from a Markdown document.
Examples
Read selected front matter from a Markdown file.
PS>
$metadata = Get-OfficeMarkdownFrontMatter -Path .\Report.md -Key 'title'
$metadata |
Select-Object -Property Key, Value |
Format-Table -AutoSize
Parses a Markdown file and returns matching front matter entries for metadata proof.
Parse front matter from generated text.
PS>
$markdown = "---`ntitle: Report`nstatus: Ready`n---`n# Report"
Get-OfficeMarkdownFrontMatter -Text $markdown |
Select-Object -Property Key, Value
Parses Markdown text directly when the document has not been saved yet.
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-OfficeMarkdownFrontMatter [-AllowDataUrls <Nullable`1>] [-AllowedUrlScheme <String[]>] [-AllowMailtoUrls <Nullable`1>] [-AllowProtocolRelativeUrls <Nullable`1>] [-BaseUri <String>] [-CaseSensitive] [-DisallowFileUrls <Nullable`1>] -InputPath <String> [-Key <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.
- CaseSensitive SwitchParameter
- Use case-sensitive matching for key filters.
- DisallowFileUrls Nullable`1
- Block file URLs while parsing Markdown links and images.
- InputPath String
- Path to the Markdown file.
- Key String
- Optional wildcard pattern matched against front matter keys.
- MaxInputCharacters Nullable`1
- Maximum Markdown input length accepted by the reader.
- NormalizeInput Nullable`1
- Applies a built-in Markdown input normalization preset before parsing.
- Options MarkdownReaderOptions
- Optional reader options used when parsing path or text input.
- Profile Nullable`1
- Named reader profile used when Options is not supplied.
- RestrictUrlSchemes Nullable`1
- Restrict parsed URL schemes to the allow-list.
Outputs
OfficeIMO.Markdown.FrontMatterBlock+Entry
Get-OfficeMarkdownFrontMatter [-AllowDataUrls <Nullable`1>] [-AllowedUrlScheme <String[]>] [-AllowMailtoUrls <Nullable`1>] [-AllowProtocolRelativeUrls <Nullable`1>] [-BaseUri <String>] [-CaseSensitive] [-DisallowFileUrls <Nullable`1>] -Document <MarkdownDoc> [-Key <String>] [-MaxInputCharacters <Nullable`1>] [-NormalizeInput <Nullable`1>] [-Options <MarkdownReaderOptions>] [-Profile <Nullable`1>] [-RestrictUrlSchemes <Nullable`1>] [<CommonParameters>]Parameter set:
DocumentParameters
- 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.
- CaseSensitive SwitchParameter
- Use case-sensitive matching for key filters.
- DisallowFileUrls Nullable`1
- Block file URLs while parsing Markdown links and images.
- Document MarkdownDoc
- Markdown document to inspect.
- Key String
- Optional wildcard pattern matched against front matter keys.
- MaxInputCharacters Nullable`1
- Maximum Markdown input length accepted by the reader.
- NormalizeInput Nullable`1
- Applies a built-in Markdown input normalization preset before parsing.
- Options MarkdownReaderOptions
- Optional reader options used when parsing path or text input.
- Profile Nullable`1
- Named reader profile used when Options is not supplied.
- RestrictUrlSchemes Nullable`1
- Restrict parsed URL schemes to the allow-list.
Outputs
OfficeIMO.Markdown.FrontMatterBlock+Entry
Get-OfficeMarkdownFrontMatter [-AllowDataUrls <Nullable`1>] [-AllowedUrlScheme <String[]>] [-AllowMailtoUrls <Nullable`1>] [-AllowProtocolRelativeUrls <Nullable`1>] [-BaseUri <String>] [-CaseSensitive] [-DisallowFileUrls <Nullable`1>] [-Key <String>] [-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.
- CaseSensitive SwitchParameter
- Use case-sensitive matching for key filters.
- DisallowFileUrls Nullable`1
- Block file URLs while parsing Markdown links and images.
- Key String
- Optional wildcard pattern matched against front matter keys.
- MaxInputCharacters Nullable`1
- Maximum Markdown input length accepted by the reader.
- NormalizeInput Nullable`1
- Applies a built-in Markdown input normalization preset before parsing.
- Options MarkdownReaderOptions
- Optional reader options used when parsing path or text input.
- Profile Nullable`1
- Named reader profile used when Options is not supplied.
- RestrictUrlSchemes Nullable`1
- Restrict parsed URL schemes to the allow-list.
- Text String
- Markdown text to parse.
Outputs
OfficeIMO.Markdown.FrontMatterBlock+Entry