Cmdlet

Add-OfficeMarkdownFrontMatter

Aliases: MarkdownFrontMatter

Module: PSWriteOffice
Aliases: MarkdownFrontMatter
Inputs: OfficeIMO.Markdown.MarkdownDocument
Outputs: OfficeIMO.Markdown.MarkdownDocument
Source: AddOfficeMarkdownFrontMatterCommand.cs:18 Edit on GitHub

Adds YAML front matter to a Markdown document.

Syntax

Add-OfficeMarkdownFrontMatter
[-InputObject] <Object>
[-PassThru]
[<CommonParameters>]

Parameter set: Context

Add-OfficeMarkdownFrontMatter
-Document <MarkdownDocument>
[-InputObject] <Object>
[-PassThru]
[<CommonParameters>]

Parameter set: Document

Examples

Add front matter from a hashtable.

MarkdownFrontMatter -InputObject @{ title = 'Weekly Report'; tags = @('ops','summary') }

Sets the document header using the supplied key/value pairs.

Parameters

-InputObject Object requiredposition: 0aliases: Data: Front matter data expressed as a hashtable or object.
-PassThru SwitchParameter optional: Emit the updated Markdown document.
-Document MarkdownDocument requiredpipeline: True (ByValue)sets: Document: Markdown document to update outside the DSL context.

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.