Add-OfficeMarkdownCode

Aliases: MarkdownCode

Namespace PSWriteOffice

Aliases

MarkdownCode

Inputs

OfficeIMO.Markdown.MarkdownDoc

Outputs

OfficeIMO.Markdown.MarkdownDoc

Source

Sources/PSWriteOffice/Cmdlets/Markdown/AddOfficeMarkdownCodeCommand.cs:24 Edit on GitHub

Adds a Markdown code block.

Remarks

Adds a Markdown code block.

Examples

Authored help example

Example 1: Add a PowerShell command block to documentation.

PS>


$script = @(
                'Import-Module PSWriteOffice'
                'Get-OfficeExcelSummary -Path .\report.xlsx'
            ) -join [Environment]::NewLine
            New-OfficeMarkdown -Path .\Cookbook.md {
                Add-OfficeMarkdownHeading -Level 2 -Text 'Workbook summary'
                Add-OfficeMarkdownCode -Language 'powershell' -Content $script
            }

Appends a fenced code block with a language identifier.

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-OfficeMarkdownCode -Content <String> [-Language <String>] [-PassThru] [<CommonParameters>]

Parameter set: Context

Parameters

Content String requiredposition: 1pipeline: False: Code content.
Language String optionalposition: 0pipeline: False: Code language identifier.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the Markdown document after appending the code block.

Outputs

OfficeIMO.Markdown.MarkdownDoc

Add-OfficeMarkdownCode -Content <String> -Document <MarkdownDoc> [-Language <String>] [-PassThru] [<CommonParameters>]

Parameter set: Document

Parameters

Content String requiredposition: 1pipeline: False: Code content.
Document MarkdownDoc requiredposition: namedpipeline: True (ByValue): Markdown document to update outside the DSL context.
Language String optionalposition: 0pipeline: False: Code language identifier.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the Markdown document after appending the code block.

Outputs

OfficeIMO.Markdown.MarkdownDoc