Project

PSWriteOffice

PowerShell document automation across OfficeIMO's document, spreadsheet, presentation, PDF, Project, Access, EPUB, invoicing, and conversion engines.

View on GitHub Releases Get package
Stars 654
Forks 82
Open issues 1
Total downloads 4,320,051
Release OfficeIMO-v3.5.3
Language: C# Updated: 2026-11-03
Cmdlet

Add-OfficeMarkdownCallout

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

Adds a Markdown callout block.

Syntax

Add-OfficeMarkdownCallout
[-Body] <String>
[-Kind] <String>
[-PassThru]
[-Title] <String>
[<CommonParameters>]
#
Parameter set: Context
Add-OfficeMarkdownCallout
[-Body] <String>
-Document <MarkdownDoc>
[-Kind] <String>
[-PassThru]
[-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' -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.

Parameters

-Body String requiredposition: 2
Callout body text.
-Kind String requiredposition: 0
Callout kind (e.g. note, tip, warning).
-PassThru SwitchParameter optional
Emit the Markdown document after appending the callout.
-Title String requiredposition: 1
Callout title.
-Document MarkdownDoc 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.