Add-OfficeMarkdownHeading.md

external help file	PSWriteOffice-help.xml
Module Name	PSWriteOffice
online version	https://github.com/EvotecIT/PSWriteOffice
schema	2.0.0

Add-OfficeMarkdownHeading

SYNOPSIS

Adds a Markdown heading.

SYNTAX

Context (Default)

Add-OfficeMarkdownHeading [[-Level] <int>] [-Text] <string> [-PassThru] [<CommonParameters>]

Document

Add-OfficeMarkdownHeading [[-Level] <int>] [-Text] <string> -Document <MarkdownDoc> [-PassThru] [<CommonParameters>]

DESCRIPTION

Adds a Markdown heading.

EXAMPLES

EXAMPLE 1

PS>MarkdownHeading -Level 2 -Text 'Overview'

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

PARAMETERS

-Document

Markdown document to update outside the DSL context.

Type: MarkdownDoc
Parameter Sets: Document
Aliases: None
Possible values: 

Required: True
Position: named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: True

-Level

Heading level (1-6).

Type: Int32
Parameter Sets: Context, Document
Aliases: None
Possible values: 

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-PassThru

Emit the Markdown document after appending the heading.

Type: SwitchParameter
Parameter Sets: Context, Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Text

Heading text.

Type: String
Parameter Sets: Context, Document
Aliases: None
Possible values: 

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

• OfficeIMO.Markdown.MarkdownDoc

OUTPUTS

• OfficeIMO.Markdown.MarkdownDoc

RELATED LINKS

• None