Add-OfficeMarkdownTaskList

Aliases: MarkdownTaskList

Namespace PSWriteOffice

Aliases

MarkdownTaskList

Inputs

OfficeIMO.Markdown.MarkdownDoc

Outputs

OfficeIMO.Markdown.MarkdownDoc

Source

Sources/PSWriteOffice/Cmdlets/Markdown/AddOfficeMarkdownTaskListCommand.cs:23 Edit on GitHub

Adds a Markdown task list.

Remarks

Adds a Markdown task list.

Examples

Authored help example

Example 1: Add a release checklist.

PS>


New-OfficeMarkdown -Path .\ReleaseChecklist.md {
                Add-OfficeMarkdownHeading -Level 1 -Text 'Release checklist'
                Add-OfficeMarkdownTaskList -Items 'Generate examples', 'Refresh docs', 'Validate artifacts', 'Publish release' -Completed 0, 1
            }

Appends an unordered task list and marks selected zero-based items as completed.

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-OfficeMarkdownTaskList [-AllCompleted] [-Completed <Int32[]>] -Items <String[]> [-PassThru] [<CommonParameters>]

Parameter set: Context

Parameters

AllCompleted SwitchParameter optionalposition: namedpipeline: False: Mark every task as completed.
Completed Int32[] optionalposition: namedpipeline: False: Zero-based item indexes that should be marked complete.
Items String[] requiredposition: 0pipeline: False: Task text entries to include in the checklist.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated Markdown document.

Outputs

OfficeIMO.Markdown.MarkdownDoc

Add-OfficeMarkdownTaskList [-AllCompleted] [-Completed <Int32[]>] -Document <MarkdownDoc> -Items <String[]> [-PassThru] [<CommonParameters>]

Parameter set: Document

Parameters

AllCompleted SwitchParameter optionalposition: namedpipeline: False: Mark every task as completed.
Completed Int32[] optionalposition: namedpipeline: False: Zero-based item indexes that should be marked complete.
Document MarkdownDoc requiredposition: namedpipeline: True (ByValue): Markdown document to update outside the DSL context.
Items String[] requiredposition: 0pipeline: False: Task text entries to include in the checklist.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated Markdown document.

Outputs

OfficeIMO.Markdown.MarkdownDoc