Add-OfficeMarkdownHeading

Aliases: MarkdownHeading

Namespace PSWriteOffice

Aliases

MarkdownHeading

Inputs

OfficeIMO.Markdown.MarkdownDoc

Outputs

OfficeIMO.Markdown.MarkdownDoc

Source

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

Adds a Markdown heading.

Remarks

Adds a Markdown heading.

Examples

Authored help example

Example 1: Add headings that feed the Markdown table of contents.

PS>


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.

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-OfficeMarkdownHeading [-Level <Int32>] [-PassThru] -Text <String> [<CommonParameters>]

Parameter set: Context

Parameters

Level Int32 optionalposition: 0pipeline: False: Heading level (1-6).
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the Markdown document after appending the heading.
Text String requiredposition: 1pipeline: False: Heading text.

Outputs

OfficeIMO.Markdown.MarkdownDoc

Add-OfficeMarkdownHeading -Document <MarkdownDoc> [-Level <Int32>] [-PassThru] -Text <String> [<CommonParameters>]

Parameter set: Document

Parameters

Document MarkdownDoc requiredposition: namedpipeline: True (ByValue): Markdown document to update outside the DSL context.
Level Int32 optionalposition: 0pipeline: False: Heading level (1-6).
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the Markdown document after appending the heading.
Text String requiredposition: 1pipeline: False: Heading text.

Outputs

OfficeIMO.Markdown.MarkdownDoc