Skip to content

Add-OfficeMarkdownCallout.md

Latest commit

 

History

History
130 lines (100 loc) · 2.46 KB

Add-OfficeMarkdownCallout.md

File metadata and controls

130 lines (100 loc) · 2.46 KB
external help file PSWriteOffice-help.xml
Module Name PSWriteOffice
online version https://github.com/EvotecIT/PSWriteOffice
schema 2.0.0

Add-OfficeMarkdownCallout

SYNOPSIS

Adds a Markdown callout block.

SYNTAX

Context (Default)

Add-OfficeMarkdownCallout [-Kind] <string> [-Title] <string> [-Body] <string> [-PassThru] [<CommonParameters>]

Document

Add-OfficeMarkdownCallout [-Kind] <string> [-Title] <string> [-Body] <string> -Document <MarkdownDoc> [-PassThru] [<CommonParameters>]

DESCRIPTION

Adds a Markdown callout block.

EXAMPLES

EXAMPLE 1

PS>MarkdownCallout -Kind 'note' -Title 'Remember' -Body 'Update the metrics.'

Appends a callout block to the document.

PARAMETERS

-Body

Callout body text.

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

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

-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

-Kind

Callout kind (e.g. note, tip, warning).

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

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

-PassThru

Emit the Markdown document after appending the callout.

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

-Title

Callout title.

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