Cmdlet

Add-OfficeMarkdownCallout

Aliases: MarkdownCallout

Module: PSWriteOffice
Aliases: MarkdownCallout
Inputs: OfficeIMO.Markdown.MarkdownDocument
Outputs: OfficeIMO.Markdown.MarkdownDocument
Source: AddOfficeMarkdownCalloutCommand.cs:21 Edit on GitHub

Adds a Markdown callout block.

Syntax

Add-OfficeMarkdownCallout
[-Kind] <String>
[-PassThru]
[-Text] <String>
[-Title] <String>
[<CommonParameters>]

Parameter set: Context

Add-OfficeMarkdownCallout
-Document <MarkdownDocument>
[-Kind] <String>
[-PassThru]
[-Text] <String>
[-Title] <String>
[<CommonParameters>]

Parameter set: Document

Examples

Add release callouts to a Markdown report.

New-OfficeMarkdown -Path .\ReleaseNotes.md {
    Add-OfficeMarkdownHeading -Level 1 -Text 'Release notes'
    Add-OfficeMarkdownCallout -Kind 'note' -Title 'Validation' -Text 'Artifacts were generated from deterministic example data.'
    Add-OfficeMarkdownCallout -Kind 'warning' -Title 'Manual step' -Text 'Open the workbook in desktop Excel before publishing pivots.'
}

Appends callout blocks while composing a Markdown report.

Parameters

-Kind String requiredposition: 0: Callout kind (e.g. note, tip, warning).
-PassThru SwitchParameter optional: Emit the Markdown document after appending the callout.
-Text String requiredposition: 2: Callout body text.
-Title String requiredposition: 1: Callout title.
-Document MarkdownDocument requiredpipeline: True (ByValue)sets: Document: Markdown document to update outside the DSL context.

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.