Cmdlet

Add-OfficeMarkdownImage

Aliases: MarkdownImage

Module: PSWriteOffice
Aliases: MarkdownImage
Inputs: OfficeIMO.Markdown.MarkdownDocument
Outputs: OfficeIMO.Markdown.MarkdownDocument
Source: AddOfficeMarkdownImageCommand.cs:22 Edit on GitHub

Adds a Markdown image.

Syntax

Add-OfficeMarkdownImage
[-Alt <String>]
[-Height <OfficeLength>]
[-PassThru]
[-Path] <String>
[-Title <String>]
[-Width <OfficeLength>]
[<CommonParameters>]

Parameter set: Context

Add-OfficeMarkdownImage
[-Alt <String>]
-Document <MarkdownDocument>
[-Height <OfficeLength>]
[-PassThru]
[-Path] <String>
[-Title <String>]
[-Width <OfficeLength>]
[<CommonParameters>]

Parameter set: Document

Examples

Add a report image with alt text and sizing.

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

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

Parameters

-Alt String optional: Alt text for the image.
-Height OfficeLength optional: Optional image height; numbers mean points and unit suffixes are accepted.
-PassThru SwitchParameter optional: Emit the Markdown document after appending the image.
-Path String requiredposition: 0: Image path or URL.
-Title String optional: Optional title for the image.
-Width OfficeLength optional: Optional image width; numbers mean points and unit suffixes are accepted.
-Document MarkdownDocument requiredpipeline: True (ByValue)sets: Document: Markdown document to update outside the DSL context.

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.