Project

PSWriteOffice

PowerShell document automation across OfficeIMO's document, spreadsheet, presentation, PDF, Project, Access, EPUB, invoicing, and conversion engines.

View on GitHub Releases Get package
Stars 654
Forks 82
Open issues 1
Total downloads 4,320,051
Release OfficeIMO-v3.5.3
Language: C# Updated: 2026-11-03
Cmdlet

Add-OfficeMarkdownTaskList

Aliases: MarkdownTaskList
Module
PSWriteOffice
Aliases
MarkdownTaskList
Inputs
OfficeIMO.Markdown.MarkdownDoc
Outputs
OfficeIMO.Markdown.MarkdownDoc
Source
AddOfficeMarkdownTaskListCommand.cs:23 Edit on GitHub

Adds a Markdown task list.

Syntax

Add-OfficeMarkdownTaskList
[-AllCompleted]
[-Completed <Int32[]>]
[-Items] <String[]>
[-PassThru]
[<CommonParameters>]
#
Parameter set: Context
Add-OfficeMarkdownTaskList
[-AllCompleted]
[-Completed <Int32[]>]
-Document <MarkdownDoc>
[-Items] <String[]>
[-PassThru]
[<CommonParameters>]
#
Parameter set: Document

Examples

Add a release checklist.

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.

Parameters

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

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.