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-OfficeMarkdownHeading

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

Adds a Markdown heading.

Syntax

Add-OfficeMarkdownHeading
[[-Level] <Int32>]
[-PassThru]
[-Text] <String>
[<CommonParameters>]
#
Parameter set: Context
Add-OfficeMarkdownHeading
-Document <MarkdownDoc>
[[-Level] <Int32>]
[-PassThru]
[-Text] <String>
[<CommonParameters>]
#
Parameter set: Document

Examples

Add headings that feed the Markdown table of contents.

New-OfficeMarkdown -Path .\Report.md {
    Add-OfficeMarkdownHeading -Level 1 -Text 'Operational Report'
    Add-OfficeMarkdownTableOfContents -Title 'Contents' -MinLevel 2 -MaxLevel 3 -PlaceAtTop
    Add-OfficeMarkdownHeading -Level 2 -Text 'Overview'
    Add-OfficeMarkdownParagraph -Text 'Current operational state.'
}

Appends headings that can be included in a generated table of contents.

Parameters

-Level Int32 optionalposition: 0
Heading level (1-6).
-PassThru SwitchParameter optional
Emit the Markdown document after appending the heading.
-Text String requiredposition: 1
Heading text.
-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.