Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 606 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
Cmdlet

Get-OfficeMarkdownFrontMatter

Module PSWriteOffice
Inputs
OfficeIMO.Markdown.MarkdownDoc
Outputs
OfficeIMO.Markdown.FrontMatterBlock+Entry
Source
GetOfficeMarkdownFrontMatterCommand.cs:27 Edit on GitHub

Gets YAML front matter entries from a Markdown document.

Syntax

Get-OfficeMarkdownFrontMatter [-AllowDataUrls <Boolean>] [-AllowedUrlScheme <String[]>] [-AllowMailtoUrls <Boolean>] [-AllowProtocolRelativeUrls <Boolean>] [-BaseUri <String>] [-CaseSensitive] [-DisallowFileUrls <Boolean>] [-Key <String>] [-MaxInputCharacters <Int32>] [-NormalizeInput <IntelligenceXTranscript|IntelligenceXTranscriptStrict|DocsLoose>] [-Options <MarkdownReaderOptions>] [-Path] <String> [-Profile <OfficeIMO|CommonMark|GitHubFlavoredMarkdown|Portable>] [-RestrictUrlSchemes <Boolean>] [<CommonParameters>]
#
Parameter set: Path
Get-OfficeMarkdownFrontMatter [-AllowDataUrls <Boolean>] [-AllowedUrlScheme <String[]>] [-AllowMailtoUrls <Boolean>] [-AllowProtocolRelativeUrls <Boolean>] [-BaseUri <String>] [-CaseSensitive] [-DisallowFileUrls <Boolean>] -Document <MarkdownDoc> [-Key <String>] [-MaxInputCharacters <Int32>] [-NormalizeInput <IntelligenceXTranscript|IntelligenceXTranscriptStrict|DocsLoose>] [-Options <MarkdownReaderOptions>] [-Profile <OfficeIMO|CommonMark|GitHubFlavoredMarkdown|Portable>] [-RestrictUrlSchemes <Boolean>] [<CommonParameters>]
#
Parameter set: Document
Get-OfficeMarkdownFrontMatter [-AllowDataUrls <Boolean>] [-AllowedUrlScheme <String[]>] [-AllowMailtoUrls <Boolean>] [-AllowProtocolRelativeUrls <Boolean>] [-BaseUri <String>] [-CaseSensitive] [-DisallowFileUrls <Boolean>] [-Key <String>] [-MaxInputCharacters <Int32>] [-NormalizeInput <IntelligenceXTranscript|IntelligenceXTranscriptStrict|DocsLoose>] [-Options <MarkdownReaderOptions>] [-Profile <OfficeIMO|CommonMark|GitHubFlavoredMarkdown|Portable>] [-RestrictUrlSchemes <Boolean>] -Text <String> [<CommonParameters>]
#
Parameter set: Text

Guides & Samples

Authored walkthroughs and practical samples linked to this command.

  • Read and Parse Markdown Content Guide

    Read Markdown as a document model and extract front matter, headings, nodes, and tables without fragile regular expressions.

Examples

Authored help example

Read selected front matter from a Markdown file.

$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.

$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.

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.
-BaseUri String optional
Base URI used to resolve and restrict relative Markdown links and images.
-CaseSensitive SwitchParameter optional
Use case-sensitive matching for key filters.
-DisallowFileUrls Boolean optional
Block file URLs while parsing Markdown links and images.
-Key String optional
Optional wildcard pattern matched against front matter keys.
-MaxInputCharacters Int32 optional
Maximum Markdown input length accepted by the reader.
-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.