Cmdlet

ConvertTo-OfficeMarkdown

Module: PSWriteOffice
Inputs: System.Object
Outputs: System.String OfficeIMO.Markdown.MarkdownDoc
Source: ConvertToOfficeMarkdownCommand.cs:32 Edit on GitHub

Converts objects into a Markdown table.

Syntax

ConvertTo-OfficeMarkdown
[-CollectionSeparator <String>]
[-DictionaryEntrySeparator <String>]
[-DictionaryKeyValueSeparator <String>]
[-DisableAutoAlign]
[-InputObject <Object>]
[-MaxCollectionItems <Int32>]
[-MaxNestingDepth <Int32>]
[-PassThru]
[<CommonParameters>]

Parameter set: All Parameter Sets

Description

Returns Markdown text by default; use -PassThru to emit a MarkdownDoc.

Examples

Convert objects to Markdown table.

$markdown = $data | ConvertTo-OfficeMarkdown

Generates Markdown table text from the input objects.

Emit a Markdown document for further editing.

$doc = $data | ConvertTo-OfficeMarkdown -PassThru
$doc.P('Totals above'); $doc.ToMarkdown()

Builds a table and appends more content using the MarkdownDoc API.

Disable auto alignment.

$markdown = $data | ConvertTo-OfficeMarkdown -DisableAutoAlign

Forces left-aligned columns instead of auto-aligned output.

Parameters

-CollectionSeparator String optional: Text used between items when a cell contains a collection.
-DictionaryEntrySeparator String optional: Text used between entries when a cell contains a dictionary.
-DictionaryKeyValueSeparator String optional: Text used between a dictionary key and value.
-DisableAutoAlign SwitchParameter optional: Disable automatic alignment heuristics for tables.
-InputObject Object optionalpipeline: True (ByValue): Objects to convert into Markdown.
-MaxCollectionItems Int32 optional: Maximum number of items allowed in one nested collection or dictionary cell. Defaults to 1,048,575; increase explicitly for trusted larger values.
-MaxNestingDepth Int32 optional: Maximum nesting depth allowed while normalizing one cell value. Defaults to 64; increase explicitly for trusted deeper values.
-PassThru SwitchParameter optional: Emit a Markdown document object instead of text.

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.