OfficeIMO

API Reference

Command

Add-OfficeMarkdownList

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

Adds a Markdown list.

Remarks

Adds a Markdown list.

Examples

Add a bullet list.


PS>MarkdownList -Items 'Alpha','Beta','Gamma'
        

Appends an unordered list 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-OfficeMarkdownList -Items <String[]> [-Ordered] [-PassThru] [-Start <Int32>] [<CommonParameters>]
#
Parameter set: Context

Parameters

Items String[] requiredposition: 0pipeline: False
List items to add.
Ordered SwitchParameter optionalposition: namedpipeline: False
Use an ordered list instead of bullets.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the Markdown document after appending the list.
Start Int32 optionalposition: namedpipeline: False
Starting number for ordered lists.

Outputs

OfficeIMO.Markdown.MarkdownDoc

Add-OfficeMarkdownList -Document <MarkdownDoc> -Items <String[]> [-Ordered] [-PassThru] [-Start <Int32>] [<CommonParameters>]
#
Parameter set: Document

Parameters

Document MarkdownDoc requiredposition: namedpipeline: True (ByValue)
Markdown document to update outside the DSL context.
Items String[] requiredposition: 0pipeline: False
List items to add.
Ordered SwitchParameter optionalposition: namedpipeline: False
Use an ordered list instead of bullets.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the Markdown document after appending the list.
Start Int32 optionalposition: namedpipeline: False
Starting number for ordered lists.

Outputs

OfficeIMO.Markdown.MarkdownDoc