Add-OfficeMarkdownQuote

Aliases: MarkdownQuote

Namespace PSWriteOffice

Aliases

MarkdownQuote

Inputs

OfficeIMO.Markdown.MarkdownDoc

Outputs

OfficeIMO.Markdown.MarkdownDoc

Source

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

Adds a Markdown block quote.

Remarks

Adds a Markdown block quote.

Examples

Authored help example

Add an executive takeaway quote.

PS>


New-OfficeMarkdown -Path .\ExecutiveSummary.md {
                Add-OfficeMarkdownHeading -Level 1 -Text 'Executive summary'
                Add-OfficeMarkdownQuote -Text 'The release is ready when examples, generated docs, and artifact readback all agree.'
                Add-OfficeMarkdownParagraph -Text 'Detailed validation follows.'
            }

Appends a quote block 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-OfficeMarkdownQuote [-PassThru] -Text <String> [<CommonParameters>]

Parameter set: Context

Parameters

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

Outputs

OfficeIMO.Markdown.MarkdownDoc

Add-OfficeMarkdownQuote -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 quote.
Text String requiredposition: 0pipeline: False: Quote text.

Outputs

OfficeIMO.Markdown.MarkdownDoc