Get-OfficeDocumentPageMarkdown

Namespace PSWriteOffice

Inputs

OfficeIMO.Reader.OfficeDocumentReadResult

Outputs

OfficeIMO.Reader.OfficeDocumentPageMarkdown System.String

Source

Sources/PSWriteOffice/Cmdlets/Reader/GetOfficeDocumentPageMarkdownCommand.cs:17 Edit on GitHub

Projects Reader pages into citation-friendly Markdown.

Remarks

Projects Reader pages into citation-friendly Markdown.

Examples

Authored help example

Create one Markdown file with page markers.

PS>


Get-OfficeDocument -Path .\Handbook.pdf |
                Get-OfficeDocumentPageMarkdown -AsString |
                Set-Content -Path .\Handbook.pages.md

Uses OfficeIMO.Reader page projection and preserves the page provenance in each marker.

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-OfficeDocumentPageMarkdown [-AsString] -InputObject <OfficeDocumentReadResult> [-NoPageMarkers] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

AsString SwitchParameter optionalposition: namedpipeline: False: Return one combined Markdown string instead of one page result per page.
InputObject OfficeDocumentReadResult requiredposition: 0pipeline: True (ByValue): Normalized document returned by Get-OfficeDocument.
NoPageMarkers SwitchParameter optionalposition: namedpipeline: False: Omit portable HTML page markers from the Markdown.

Outputs

OfficeIMO.Reader.OfficeDocumentPageMarkdown System.String