Add-OfficeMarkdownImage

Aliases: MarkdownImage

Namespace PSWriteOffice

Aliases

MarkdownImage

Inputs

OfficeIMO.Markdown.MarkdownDoc

Outputs

OfficeIMO.Markdown.MarkdownDoc

Source

Sources/PSWriteOffice/Cmdlets/Markdown/AddOfficeMarkdownImageCommand.cs:20 Edit on GitHub

Adds a Markdown image.

Remarks

Adds a Markdown image.

Examples

Authored help example

Example 1: Add a report image with alt text and sizing.

PS>


New-OfficeMarkdown -Path .\Report.md {
                Add-OfficeMarkdownHeading -Level 2 -Text 'Architecture'
                Add-OfficeMarkdownImage -Path '.\Assets\architecture.png' -Alt 'Architecture diagram' -Title 'Current architecture' -Width 640
            }

Appends an image block with accessibility text and optional presentation metadata.

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-OfficeMarkdownImage [-Alt <String>] [-Height <Nullable`1>] [-PassThru] -Path <String> [-Title <String>] [-Width <Nullable`1>] [<CommonParameters>]

Parameter set: Context

Parameters

Alt String optionalposition: namedpipeline: False: Alt text for the image.
Height Nullable`1 optionalposition: namedpipeline: False: Optional height in pixels.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the Markdown document after appending the image.
Path String requiredposition: 0pipeline: False: Image path or URL.
Title String optionalposition: namedpipeline: False: Optional title for the image.
Width Nullable`1 optionalposition: namedpipeline: False: Optional width in pixels.

Outputs

OfficeIMO.Markdown.MarkdownDoc

Add-OfficeMarkdownImage [-Alt <String>] -Document <MarkdownDoc> [-Height <Nullable`1>] [-PassThru] -Path <String> [-Title <String>] [-Width <Nullable`1>] [<CommonParameters>]

Parameter set: Document

Parameters

Alt String optionalposition: namedpipeline: False: Alt text for the image.
Document MarkdownDoc requiredposition: namedpipeline: True (ByValue): Markdown document to update outside the DSL context.
Height Nullable`1 optionalposition: namedpipeline: False: Optional height in pixels.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the Markdown document after appending the image.
Path String requiredposition: 0pipeline: False: Image path or URL.
Title String optionalposition: namedpipeline: False: Optional title for the image.
Width Nullable`1 optionalposition: namedpipeline: False: Optional width in pixels.

Outputs

OfficeIMO.Markdown.MarkdownDoc