Add-OfficeMarkdownDefinitionList

Aliases: MarkdownDefinitionList

Namespace PSWriteOffice

Aliases

MarkdownDefinitionList

Inputs

OfficeIMO.Markdown.MarkdownDoc

Outputs

OfficeIMO.Markdown.MarkdownDoc

Source

Sources/PSWriteOffice/Cmdlets/Markdown/AddOfficeMarkdownDefinitionListCommand.cs:19 Edit on GitHub

Adds a Markdown definition list.

Remarks

Adds a Markdown definition list.

Examples

Authored help example

Add term/definition pairs.

PS>


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

Appends a definition list built from the provided pairs.

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-OfficeMarkdownDefinitionList -Definition <Hashtable> [-PassThru] [<CommonParameters>]

Parameter set: Context

Parameters

Definition Hashtable requiredposition: 0pipeline: False: Hashtable of term/definition pairs to render.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated Markdown document.

Outputs

OfficeIMO.Markdown.MarkdownDoc

Add-OfficeMarkdownDefinitionList -Definition <Hashtable> -Document <MarkdownDoc> [-PassThru] [<CommonParameters>]

Parameter set: Document

Parameters

Definition Hashtable requiredposition: 0pipeline: False: Hashtable of term/definition pairs to render.
Document MarkdownDoc requiredposition: namedpipeline: True (ByValue): Markdown document to update outside the DSL context.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated Markdown document.

Outputs

OfficeIMO.Markdown.MarkdownDoc