Evotec

Project

PSWriteOffice

PSWriteOffice is an open-source PowerShell and .NET project with packages, release history, and technical documentation.

Stars 144
Forks 12
Open issues 16
PowerShell Gallery downloads 150,904
Release v0.2.0
Language: C# Updated: 2026-04-06

API Reference

Cmdlet

Add-OfficeMarkdownCallout

Namespace PSWriteOffice
Inputs
OfficeIMO.Markdown.MarkdownDoc
Outputs
OfficeIMO.Markdown.MarkdownDoc

Adds a Markdown callout block.

Remarks

Adds a Markdown callout block.

Examples

Authored help example

Add a note callout.

PS>


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

Appends a callout block to the document.

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