Get-OfficeMarkdown

Namespace PSWriteOffice

Inputs

None

Outputs

OfficeIMO.Markdown.MarkdownDoc

Parses Markdown text or files into a Markdown document model.

Remarks

Parses Markdown text or files into a Markdown document model.

Examples

Parse a Markdown file.


PS>$md = Get-OfficeMarkdown -Path .\README.md

Loads the file into a Markdown document object.

Parse Markdown text in-memory.


PS>$md = Get-OfficeMarkdown -Text '# Title`n`nBody text'

Parses Markdown text directly into a document model.

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

Get-OfficeMarkdown -InputPath <String> [-Options <MarkdownReaderOptions>] [-Profile <Nullable`1>] [<CommonParameters>]

Parameter set: Path

Parameters

InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path: Path to the Markdown file.
Options MarkdownReaderOptions optionalposition: namedpipeline: False: Optional reader options.
Profile Nullable`1 optionalposition: namedpipeline: False: Named reader profile used when Options is not supplied.

Outputs

OfficeIMO.Markdown.MarkdownDoc

Get-OfficeMarkdown [-Options <MarkdownReaderOptions>] [-Profile <Nullable`1>] -Text <String> [<CommonParameters>]

Parameter set: Text

Parameters

Options MarkdownReaderOptions optionalposition: namedpipeline: False: Optional reader options.
Profile Nullable`1 optionalposition: namedpipeline: False: Named reader profile used when Options is not supplied.
Text String requiredposition: namedpipeline: False: Markdown text to parse.

Outputs

OfficeIMO.Markdown.MarkdownDoc