Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Cmdlet

Add-OfficeMarkdownDefinitionList

Aliases: MarkdownDefinitionList
Module
PSWriteOffice
Aliases
MarkdownDefinitionList
Inputs
OfficeIMO.Markdown.MarkdownDocument
Outputs
OfficeIMO.Markdown.MarkdownDocument

Adds a Markdown definition list.

Syntax

Add-OfficeMarkdownDefinitionList
[-Definition] <IDictionary>
[-PassThru]
[<CommonParameters>]
#
Parameter set: Context
Add-OfficeMarkdownDefinitionList
[-Definition] <IDictionary>
-Document <MarkdownDocument>
[-PassThru]
[<CommonParameters>]
#
Parameter set: Document

Examples

Add term/definition pairs.

MarkdownDefinitionList -Definition @{ SLA = 'Service level agreement'; SLO = 'Service level objective' }

Appends a definition list built from the provided pairs.

Parameters

-Definition IDictionary requiredposition: 0
Dictionary of term/definition pairs to render.
-PassThru SwitchParameter optional
Emit the updated Markdown document.
-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.