OfficeIMO

API Reference

Command

Add-OfficeMarkdownHeading

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

Adds a Markdown heading.

Remarks

Adds a Markdown heading.

Examples

Add a second-level heading.


PS>MarkdownHeading -Level 2 -Text 'Overview'

Appends a level-2 heading to the current Markdown document.

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-OfficeMarkdownHeading [-Level <Int32>] [-PassThru] -Text <String> [<CommonParameters>]
#
Parameter set: Context

Parameters

Level Int32 optionalposition: 0pipeline: False
Heading level (1-6).
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the Markdown document after appending the heading.
Text String requiredposition: 1pipeline: False
Heading text.

Outputs

OfficeIMO.Markdown.MarkdownDoc

Add-OfficeMarkdownHeading -Document <MarkdownDoc> [-Level <Int32>] [-PassThru] -Text <String> [<CommonParameters>]
#
Parameter set: Document

Parameters

Document MarkdownDoc requiredposition: namedpipeline: True (ByValue)
Markdown document to update outside the DSL context.
Level Int32 optionalposition: 0pipeline: False
Heading level (1-6).
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the Markdown document after appending the heading.
Text String requiredposition: 1pipeline: False
Heading text.

Outputs

OfficeIMO.Markdown.MarkdownDoc