Evotec

Project

PSWriteOffice

PSWriteOffice is an open-source PowerShell and .NET project with packages, release history, and technical documentation.

Stars 144
Forks 12
Open issues 16
PowerShell Gallery downloads 150,904
Release v0.2.0
Language: C# Updated: 2026-04-06

API Reference

Cmdlet

Add-OfficeMarkdownTaskList

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

Adds a Markdown task list.

Remarks

Adds a Markdown task list.

Examples

Authored help example

Add a checklist.

PS>


MarkdownTaskList -Items 'Draft','Review','Ship' -Completed 1
        

Appends an unordered task list and marks the selected 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