Cmdlet

Save-OfficeMarkdown

Module PSWriteOffice

Inputs

OfficeIMO.Markdown.MarkdownDoc

Outputs

OfficeIMO.Markdown.MarkdownDoc

Source

SaveOfficeMarkdownCommand.cs:19 Edit on GitHub

Saves a Markdown document without changing its lifetime.

Syntax

Save-OfficeMarkdown [-Document] <MarkdownDoc> [-ImageRenderingMode <RichMarkdown|PortableMarkdown|Html>] [-LineEnding <String>] [-PassThru] [-Path] <String> [-UnorderedListMarker <String>] [-WriteOptions <MarkdownWriteOptions>] [-WriteProfile <OfficeIMO|Portable|HtmlImage>] [<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Authored help example

Save a Markdown document.

$doc | Save-OfficeMarkdown -Path .\Report.md

Writes the Markdown artifact and keeps the document available for further changes.

Parameters

-Document MarkdownDoc requiredposition: 0pipeline: True (ByValue): Markdown document to save.
-ImageRenderingMode MarkdownImageRenderingMode optional: Controls how Markdown images are serialized.; Possible values: RichMarkdown, PortableMarkdown, Html
-LineEnding String optional: Markdown line ending: CRLF, LF, CR, or a literal line ending string.
-PassThru SwitchParameter optional: Emit the Markdown document rather than the saved file.
-Path String requiredposition: 1aliases: FilePath: Destination Markdown path.
-UnorderedListMarker String optional: Unordered list marker: '-', '*', or '+'.
-WriteOptions MarkdownWriteOptions optional: Optional Markdown writer options.
-WriteProfile OfficeMarkdownWriteProfile optional: Friendly Markdown writer profile.; Possible values: OfficeIMO, Portable, HtmlImage

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.