Add-OfficeMarkdownHorizontalRule

Aliases: MarkdownHorizontalRule, MarkdownHr

Namespace PSWriteOffice

Aliases

MarkdownHorizontalRule MarkdownHr

Inputs

OfficeIMO.Markdown.MarkdownDoc

Outputs

OfficeIMO.Markdown.MarkdownDoc

Source

Sources/PSWriteOffice/Cmdlets/Markdown/AddOfficeMarkdownHorizontalRuleCommand.cs:22 Edit on GitHub

Adds a Markdown horizontal rule.

Remarks

Adds a Markdown horizontal rule.

Examples

Authored help example

Example 1: Separate summary and appendix sections.

PS>


New-OfficeMarkdown -Path .\Report.md {
                Add-OfficeMarkdownHeading -Level 2 -Text 'Summary'
                Add-OfficeMarkdownParagraph -Text 'Key decisions and status.'
                Add-OfficeMarkdownHorizontalRule
                Add-OfficeMarkdownHeading -Level 2 -Text 'Appendix'
            }

Appends a horizontal rule between sections of the current Markdown document.

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-OfficeMarkdownHorizontalRule [-PassThru] [<CommonParameters>]

Parameter set: Context

Parameters

PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the Markdown document after appending the rule.

Outputs

OfficeIMO.Markdown.MarkdownDoc

Add-OfficeMarkdownHorizontalRule -Document <MarkdownDoc> [-PassThru] [<CommonParameters>]

Parameter set: Document

Parameters

Document MarkdownDoc requiredposition: namedpipeline: True (ByValue): Markdown document to update outside the DSL context.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the Markdown document after appending the rule.

Outputs

OfficeIMO.Markdown.MarkdownDoc