ConvertTo-OfficeAsciiDocMarkdown

Namespace PSWriteOffice

Inputs

OfficeIMO.AsciiDoc.AsciiDocDocument

Outputs

OfficeIMO.AsciiDoc.Markdown.AsciiDocToMarkdownResult

Source

Sources/PSWriteOffice/Cmdlets/AsciiDoc/ConvertToOfficeAsciiDocMarkdownCommand.cs:9 Edit on GitHub

Converts AsciiDoc to Markdown with fidelity diagnostics.

Remarks

Converts AsciiDoc to Markdown with fidelity diagnostics.

Examples

Authored help example

EXAMPLE 1


ConvertTo-OfficeAsciiDocMarkdown -Path 'C:\Path'

EXAMPLE 2


ConvertTo-OfficeAsciiDocMarkdown -Document 'Value'

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

ConvertTo-OfficeAsciiDocMarkdown [-FailOnLoss] [-Options <AsciiDocToMarkdownOptions>] [-OutputPath <String>] -Path <String> [<CommonParameters>]

Parameter set: Path

Parameters

FailOnLoss SwitchParameter optionalposition: namedpipeline: False: Throw when a source feature cannot be mapped exactly.
Options AsciiDocToMarkdownOptions optionalposition: namedpipeline: False: Optional conversion settings.
OutputPath String optionalposition: namedpipeline: False: Optional Markdown destination path.
Path String requiredposition: 0pipeline: False: Path to an AsciiDoc file.

Outputs

OfficeIMO.AsciiDoc.Markdown.AsciiDocToMarkdownResult

ConvertTo-OfficeAsciiDocMarkdown -Document <AsciiDocDocument> [-FailOnLoss] [-Options <AsciiDocToMarkdownOptions>] [-OutputPath <String>] [<CommonParameters>]

Parameter set: Document

Parameters

Document AsciiDocDocument requiredposition: namedpipeline: True (ByValue): AsciiDoc document to convert.
FailOnLoss SwitchParameter optionalposition: namedpipeline: False: Throw when a source feature cannot be mapped exactly.
Options AsciiDocToMarkdownOptions optionalposition: namedpipeline: False: Optional conversion settings.
OutputPath String optionalposition: namedpipeline: False: Optional Markdown destination path.

Outputs

OfficeIMO.AsciiDoc.Markdown.AsciiDocToMarkdownResult