Add-OfficeMarkdownList

Aliases: MarkdownList

Namespace PSWriteOffice

Aliases

MarkdownList

Inputs

OfficeIMO.Markdown.MarkdownDoc

Outputs

OfficeIMO.Markdown.MarkdownDoc

Source

Sources/PSWriteOffice/Cmdlets/Markdown/AddOfficeMarkdownListCommand.cs:25 Edit on GitHub

Adds a Markdown list.

Remarks

Adds a Markdown list.

Examples

Authored help example

Example 1: Add ordered and unordered lists to a report.

PS>


New-OfficeMarkdown -Path .\Plan.md {
                Add-OfficeMarkdownHeading -Level 2 -Text 'Priorities'
                Add-OfficeMarkdownList -Items 'PDF examples', 'PowerPoint layout', 'Word report polish'
                Add-OfficeMarkdownHeading -Level 2 -Text 'Release order'
                Add-OfficeMarkdownList -Items 'Validate artifacts', 'Generate docs', 'Publish release' -Ordered -Start 1
            }

Appends bullet and ordered lists to the current Markdown 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