Add-OfficeMarkdownParagraph

Aliases: MarkdownParagraph

Namespace PSWriteOffice

Aliases

MarkdownParagraph

Inputs

OfficeIMO.Markdown.MarkdownDoc

Outputs

OfficeIMO.Markdown.MarkdownDoc

Source

Sources/PSWriteOffice/Cmdlets/Markdown/AddOfficeMarkdownParagraphCommand.cs:21 Edit on GitHub

Adds a Markdown paragraph.

Remarks

Adds a Markdown paragraph.

Examples

Authored help example

Example 1: Add narrative text between generated sections.

PS>


New-OfficeMarkdown -Path .\Report.md {
                Add-OfficeMarkdownHeading -Level 1 -Text 'Operational Report'
                Add-OfficeMarkdownParagraph -Text 'This report is generated automatically from validated source data.'
                Add-OfficeMarkdownParagraph -Text 'Use the linked artifacts for workbook, PDF, and presentation proof.'
            }

Appends paragraph text to 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-OfficeMarkdownParagraph [-PassThru] -Text <String> [<CommonParameters>]

Parameter set: Context

Parameters

PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the Markdown document after appending the paragraph.
Text String requiredposition: 0pipeline: False: Paragraph text.

Outputs

OfficeIMO.Markdown.MarkdownDoc

Add-OfficeMarkdownParagraph -Document <MarkdownDoc> [-PassThru] -Text <String> [<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 paragraph.
Text String requiredposition: 0pipeline: False: Paragraph text.

Outputs

OfficeIMO.Markdown.MarkdownDoc