OfficeIMO

API Reference

Command

Add-OfficeMarkdownFrontMatter

Namespace PSWriteOffice
Inputs
OfficeIMO.Markdown.MarkdownDoc
Outputs
OfficeIMO.Markdown.MarkdownDoc

Adds YAML front matter to a Markdown document.

Remarks

Adds YAML front matter to a Markdown document.

Examples

Add front matter from a hashtable.


PS>MarkdownFrontMatter -Data @{ 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 -Data <Object> [-PassThru] [<CommonParameters>]
#
Parameter set: Context

Parameters

Data Object requiredposition: 0pipeline: False
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 -Data <Object> -Document <MarkdownDoc> [-PassThru] [<CommonParameters>]
#
Parameter set: Document

Parameters

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

Outputs

OfficeIMO.Markdown.MarkdownDoc