Add-OfficeMarkdownFrontMatter

Aliases: MarkdownFrontMatter

Namespace PSWriteOffice

Aliases

MarkdownFrontMatter

Inputs

OfficeIMO.Markdown.MarkdownDoc

Outputs

OfficeIMO.Markdown.MarkdownDoc

Source

Sources/PSWriteOffice/Cmdlets/Markdown/AddOfficeMarkdownFrontMatterCommand.cs:21 Edit on GitHub

Adds YAML front matter to a Markdown document.

Remarks

Adds YAML front matter to a Markdown document.

Examples

Authored help example

Add front matter from a hashtable.

PS>


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

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

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

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

Parameter set: Context

Parameters

InputObject Object requiredposition: 0pipeline: Falsealiases: Data: Front matter data expressed as a hashtable or object.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated Markdown document.

Outputs

OfficeIMO.Markdown.MarkdownDoc

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

Parameter set: Document

Parameters

Document MarkdownDoc requiredposition: namedpipeline: True (ByValue): Markdown document to update outside the DSL context.
InputObject Object requiredposition: 0pipeline: Falsealiases: Data: Front matter data expressed as a hashtable or object.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated Markdown document.

Outputs

OfficeIMO.Markdown.MarkdownDoc