Cmdlet

ConvertTo-OfficeMarkdownHtml

Aliases: ConvertTo-MarkdownHtml

Module: PSWriteOffice
Aliases: ConvertTo-MarkdownHtml
Inputs: OfficeIMO.Markdown.MarkdownDoc
Outputs: System.String System.IO.FileInfo
Source: ConvertToOfficeMarkdownHtmlCommand.cs:27 Edit on GitHub

Converts Markdown content to HTML.

Syntax

ConvertTo-OfficeMarkdownHtml
[-AllowDataUrls <Boolean>]
[-AllowedHttpImageHost <String[]>]
[-AllowedHttpLinkHost <String[]>]
[-AllowedUrlScheme <String[]>]
[-AllowMailtoUrls <Boolean>]
[-AllowProtocolRelativeUrls <Boolean>]
[-AssetMode <Online|Offline>]
[-BaseUri <String>]
[-BlockExternalHttpImages]
[-CssDelivery <Inline|ExternalFile|LinkHref>]
[-DisallowFileUrls <Boolean>]
[-DocumentMode]
[-ExternalLinksReferrerPolicy <String>]
[-ExternalLinksRel <String>]
[-ExternalLinksTargetBlank]
[-GitHubFootnoteHtml]
[-GitHubTaskListHtml]
[-ImagesDecodingAsync]
[-ImagesLoadingLazy]
[-ImagesReferrerPolicy <String>]
[-IncludeAnchorLinks]
[-MaxInputCharacters <Int32>]
[-NormalizeInput <IntelligenceXTranscript|IntelligenceXTranscriptStrict|DocsLoose>]
[-OutputPath <String>]
[-PassThru]
[-Path] <String>
[-Profile <OfficeIMO|CommonMark|GitHubFlavoredMarkdown|Portable>]
[-RawHtmlHandling <Allow|Escape|Sanitize|Strip>]
[-ReaderOptions <MarkdownReaderOptions>]
[-RestrictHttpImagesToBaseOrigin]
[-RestrictHttpLinksToBaseOrigin]
[-RestrictUrlSchemes <Boolean>]
[-Style <HtmlStyle>]
[-Theme <OfficeVisualThemeKind>]
[-Title <String>]
[<CommonParameters>]

Parameter set: Path

ConvertTo-OfficeMarkdownHtml
[-AllowDataUrls <Boolean>]
[-AllowedHttpImageHost <String[]>]
[-AllowedHttpLinkHost <String[]>]
[-AllowedUrlScheme <String[]>]
[-AllowMailtoUrls <Boolean>]
[-AllowProtocolRelativeUrls <Boolean>]
[-AssetMode <Online|Offline>]
[-BaseUri <String>]
[-BlockExternalHttpImages]
[-CssDelivery <Inline|ExternalFile|LinkHref>]
[-DisallowFileUrls <Boolean>]
[-DocumentMode]
[-ExternalLinksReferrerPolicy <String>]
[-ExternalLinksRel <String>]
[-ExternalLinksTargetBlank]
[-GitHubFootnoteHtml]
[-GitHubTaskListHtml]
[-ImagesDecodingAsync]
[-ImagesLoadingLazy]
[-ImagesReferrerPolicy <String>]
[-IncludeAnchorLinks]
[-MaxInputCharacters <Int32>]
[-NormalizeInput <IntelligenceXTranscript|IntelligenceXTranscriptStrict|DocsLoose>]
[-OutputPath <String>]
[-PassThru]
[-Profile <OfficeIMO|CommonMark|GitHubFlavoredMarkdown|Portable>]
[-RawHtmlHandling <Allow|Escape|Sanitize|Strip>]
[-ReaderOptions <MarkdownReaderOptions>]
[-RestrictHttpImagesToBaseOrigin]
[-RestrictHttpLinksToBaseOrigin]
[-RestrictUrlSchemes <Boolean>]
[-Style <HtmlStyle>]
-Text <String>
[-Theme <OfficeVisualThemeKind>]
[-Title <String>]
[<CommonParameters>]

Parameter set: Text

ConvertTo-OfficeMarkdownHtml
[-AllowDataUrls <Boolean>]
[-AllowedHttpImageHost <String[]>]
[-AllowedHttpLinkHost <String[]>]
[-AllowedUrlScheme <String[]>]
[-AllowMailtoUrls <Boolean>]
[-AllowProtocolRelativeUrls <Boolean>]
[-AssetMode <Online|Offline>]
[-BaseUri <String>]
[-BlockExternalHttpImages]
[-CssDelivery <Inline|ExternalFile|LinkHref>]
[-DisallowFileUrls <Boolean>]
-Document <MarkdownDoc>
[-DocumentMode]
[-ExternalLinksReferrerPolicy <String>]
[-ExternalLinksRel <String>]
[-ExternalLinksTargetBlank]
[-GitHubFootnoteHtml]
[-GitHubTaskListHtml]
[-ImagesDecodingAsync]
[-ImagesLoadingLazy]
[-ImagesReferrerPolicy <String>]
[-IncludeAnchorLinks]
[-MaxInputCharacters <Int32>]
[-NormalizeInput <IntelligenceXTranscript|IntelligenceXTranscriptStrict|DocsLoose>]
[-OutputPath <String>]
[-PassThru]
[-Profile <OfficeIMO|CommonMark|GitHubFlavoredMarkdown|Portable>]
[-RawHtmlHandling <Allow|Escape|Sanitize|Strip>]
[-ReaderOptions <MarkdownReaderOptions>]
[-RestrictHttpImagesToBaseOrigin]
[-RestrictHttpLinksToBaseOrigin]
[-RestrictUrlSchemes <Boolean>]
[-Style <HtmlStyle>]
[-Theme <OfficeVisualThemeKind>]
[-Title <String>]
[<CommonParameters>]

Parameter set: Document

Description

Returns HTML text or saves it to a file when -OutputPath is specified.

Examples

Convert a Markdown file to HTML.

$html = ConvertTo-OfficeMarkdownHtml -Path .\README.md

Returns the rendered HTML.

Save a styled HTML document.

ConvertTo-OfficeMarkdownHtml -Path .\Report.md -DocumentMode -Title 'Weekly Report' -Style Clean -OutputPath .\Report.html -PassThru

Generates a full HTML file with title and CSS styling.

Parameters

-AllowDataUrls Boolean optional: Allow data URLs while parsing Markdown links and images.
-AllowedHttpImageHost String[] optional: Allowed HTTP(S) image hosts.
-AllowedHttpLinkHost String[] optional: Allowed HTTP(S) link hosts.
-AllowedUrlScheme String[] optional: Allowed URL schemes when URL scheme restriction is enabled.
-AllowMailtoUrls Boolean optional: Allow mailto URLs while parsing Markdown links.
-AllowProtocolRelativeUrls Boolean optional: Allow protocol-relative URLs while parsing Markdown links and images.
-AssetMode AssetMode optional: Asset loading mode.; Possible values: Online, Offline
-BaseUri String optional: Base URI used to resolve and restrict relative Markdown links and images.
-BlockExternalHttpImages SwitchParameter optional: Block all absolute external HTTP(S) images.
-CssDelivery CssDelivery optional: CSS delivery mode.; Possible values: Inline, ExternalFile, LinkHref
-DisallowFileUrls Boolean optional: Block file URLs while parsing Markdown links and images.
-DocumentMode SwitchParameter optional: Render a full HTML document instead of a fragment.
-ExternalLinksReferrerPolicy String optional: referrerpolicy value for external HTTP(S) links.
-ExternalLinksRel String optional: rel attribute value for external HTTP(S) links.
-ExternalLinksTargetBlank SwitchParameter optional: Open external HTTP(S) links in a new tab.
-GitHubFootnoteHtml SwitchParameter optional: Emit GitHub-compatible footnote HTML.
-GitHubTaskListHtml SwitchParameter optional: Emit GitHub-compatible task-list HTML.
-ImagesDecodingAsync SwitchParameter optional: Add decoding="async" to rendered images.
-ImagesLoadingLazy SwitchParameter optional: Add loading="lazy" to rendered images.
-ImagesReferrerPolicy String optional: referrerpolicy value for rendered images.
-IncludeAnchorLinks SwitchParameter optional: Add anchor links to headings.
-MaxInputCharacters Int32 optional: Maximum Markdown input length accepted by the reader.
-NormalizeInput MarkdownInputNormalizationPreset optional: Applies a built-in Markdown input normalization preset before parsing.; Possible values: IntelligenceXTranscript, IntelligenceXTranscriptStrict, DocsLoose
-OutputPath String optionalaliases: OutPath: Optional output path for the HTML file.
-PassThru SwitchParameter optional: Emit a FileInfo when saving to disk.
-Path String requiredposition: 0aliases: FilePath, InputPathsets: Path: Path to the Markdown file.
-Profile MarkdownDialectProfile optional: Named reader profile used when ReaderOptions is not supplied.; Possible values: OfficeIMO, CommonMark, GitHubFlavoredMarkdown, Portable
-RawHtmlHandling RawHtmlHandling optional: Controls how raw HTML blocks are emitted.; Possible values: Allow, Escape, Sanitize, Strip
-ReaderOptions MarkdownReaderOptions optional: Optional reader options when parsing Markdown.
-RestrictHttpImagesToBaseOrigin SwitchParameter optional: Restrict absolute HTTP(S) images to the base origin.
-RestrictHttpLinksToBaseOrigin SwitchParameter optional: Restrict absolute HTTP(S) links to the base origin.
-RestrictUrlSchemes Boolean optional: Restrict parsed URL schemes to the allow-list.
-Style HtmlStyle optional: Built-in HTML style preset.; Possible values: Plain, Clean, GithubLight, GithubDark, GithubAuto, ChatLight, ChatDark, ChatAuto, Word
-Theme OfficeVisualThemeKind optional: Shared Markdown visual theme for HTML output.; Possible values: Plain, WordLike, TechnicalDocument, GitHubLike, Compact, Report
-Title String optional: Optional title for HTML documents.
-Text String requiredsets: Text: Markdown text to convert.
-Document MarkdownDoc requiredpipeline: True (ByValue)sets: Document: Markdown document to convert.

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.