Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 658 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
Cmdlet

New-OfficeWordMarkdownOptions

Module
PSWriteOffice
Inputs
None
Outputs
OfficeIMO.Word.Markdown.WordMarkdownExportOptions
Source
NewOfficeWordMarkdownOptionsCommand.cs:13 Edit on GitHub

Creates native Word-to-Markdown options for Convert-OfficeDocument.

Syntax

New-OfficeWordMarkdownOptions
[-EnableHighlight]
[-EnableUnderline]
[-Font <String>]
[-ImageDirectory <String>]
[-ImageExportMode <Base64|File>]
[<CommonParameters>]
#
Parameter set: Default

Examples

Retain underline and highlight markup in a runbook.

$options = New-OfficeWordMarkdownOptions -EnableUnderline -EnableHighlight
Convert-OfficeDocument -Path ./Runbook.docx -To Markdown -OutputPath ./Runbook.md -Options $options

Parameters

-EnableHighlight SwitchParameter optional
Wrap highlighted text in double equals signs.
-EnableUnderline SwitchParameter optional
Wrap underlined text in HTML underline tags.
-Font String optional
Font family whose runs become inline code; omission uses the native monospace resolver.
-ImageDirectory String optional
Filesystem folder for images when File mode is selected; this command does not create it.
-ImageExportMode WordMarkdownImageExportMode optional
Embed images as Base64 or save them as File references.
Possible values: Base64, File

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.