Add-OfficeMarkdownCallout

Aliases: MarkdownCallout

Namespace PSWriteOffice

Aliases

MarkdownCallout

Inputs

OfficeIMO.Markdown.MarkdownDoc

Outputs

OfficeIMO.Markdown.MarkdownDoc

Source

Sources/PSWriteOffice/Cmdlets/Markdown/AddOfficeMarkdownCalloutCommand.cs:21 Edit on GitHub

Adds a Markdown callout block.

Remarks

Adds a Markdown callout block.

Examples

Authored help example

Add release callouts to a Markdown report.

PS>


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

Appends callout blocks while composing a Markdown report.

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-OfficeMarkdownCallout -Body <String> -Kind <String> [-PassThru] -Title <String> [<CommonParameters>]

Parameter set: Context

Parameters

Body String requiredposition: 2pipeline: False: Callout body text.
Kind String requiredposition: 0pipeline: False: Callout kind (e.g. note, tip, warning).
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the Markdown document after appending the callout.
Title String requiredposition: 1pipeline: False: Callout title.

Outputs

OfficeIMO.Markdown.MarkdownDoc

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

Parameter set: Document

Parameters

Body String requiredposition: 2pipeline: False: Callout body text.
Document MarkdownDoc requiredposition: namedpipeline: True (ByValue): Markdown document to update outside the DSL context.
Kind String requiredposition: 0pipeline: False: Callout kind (e.g. note, tip, warning).
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the Markdown document after appending the callout.
Title String requiredposition: 1pipeline: False: Callout title.

Outputs

OfficeIMO.Markdown.MarkdownDoc