AsciiDocMarkdownConverterExtensions
OfficeIMO.AsciiDoc.Markdown
Loss-aware conversions between AsciiDoc and Markdown models.
Inheritance
- object
- AsciiDocMarkdownConverterExtensions
Methods
public static OfficeConversionReport SaveAsAsciiDoc(MarkdownDocument document, string path, MarkdownAsciiDocExportOptions? options = null, CancellationToken cancellationToken = default) #Writes converted AsciiDoc and returns the report, including native evidence.
Parameters
- document OfficeIMO.Markdown.MarkdownDocument
- path string
- options OfficeIMO.AsciiDoc.Markdown.MarkdownAsciiDocExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static OfficeConversionReport SaveAsAsciiDoc(MarkdownDocument document, Stream stream, MarkdownAsciiDocExportOptions? options = null, CancellationToken cancellationToken = default) #Writes converted AsciiDoc and returns the report, including native evidence.
Parameters
- document OfficeIMO.Markdown.MarkdownDocument
- stream System.IO.Stream
- options OfficeIMO.AsciiDoc.Markdown.MarkdownAsciiDocExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static async Task<OfficeConversionReport> SaveAsAsciiDocAsync(MarkdownDocument document, string path, MarkdownAsciiDocExportOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously writes converted AsciiDoc and returns the report, including native evidence.
Parameters
- document OfficeIMO.Markdown.MarkdownDocument
- path string
- options OfficeIMO.AsciiDoc.Markdown.MarkdownAsciiDocExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static async Task<OfficeConversionReport> SaveAsAsciiDocAsync(MarkdownDocument document, Stream stream, MarkdownAsciiDocExportOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously writes converted AsciiDoc and returns the report, including native evidence.
Parameters
- document OfficeIMO.Markdown.MarkdownDocument
- stream System.IO.Stream
- options OfficeIMO.AsciiDoc.Markdown.MarkdownAsciiDocExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static OfficeConversionReport SaveAsMarkdown(AsciiDocDocument document, string path, AsciiDocMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #Writes converted Markdown and returns the report, including native evidence.
Parameters
- document OfficeIMO.AsciiDoc.AsciiDocDocument
- path string
- options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static OfficeConversionReport SaveAsMarkdown(AsciiDocDocument document, Stream stream, AsciiDocMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #Writes converted Markdown and returns the report, including native evidence.
Parameters
- document OfficeIMO.AsciiDoc.AsciiDocDocument
- stream System.IO.Stream
- options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static async Task<OfficeConversionReport> SaveAsMarkdownAsync(AsciiDocDocument document, string path, AsciiDocMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously writes converted Markdown and returns the report, including native evidence.
Parameters
- document OfficeIMO.AsciiDoc.AsciiDocDocument
- path string
- options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static async Task<OfficeConversionReport> SaveAsMarkdownAsync(AsciiDocDocument document, Stream stream, AsciiDocMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously writes converted Markdown and returns the report, including native evidence.
Parameters
- document OfficeIMO.AsciiDoc.AsciiDocDocument
- stream System.IO.Stream
- options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static AsciiDocDocument ToAsciiDoc(MarkdownDocument document, MarkdownAsciiDocExportOptions? options = null, CancellationToken cancellationToken = default) #Converts into a detached AsciiDoc model.
Parameters
- document OfficeIMO.Markdown.MarkdownDocument
- options OfficeIMO.AsciiDoc.Markdown.MarkdownAsciiDocExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
AsciiDocDocumentpublic static AsciiDocDocument ToAsciiDoc(MarkdownDocument document, MarkdownAsciiDocExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #Converts and retains native diagnostic locations and canonical source evidence.
Parameters
- document OfficeIMO.Markdown.MarkdownDocument
- options OfficeIMO.AsciiDoc.Markdown.MarkdownAsciiDocExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
AsciiDocDocumentpublic static Task<OfficeConversionResult<AsciiDocDocument>> ToAsciiDocAsync(MarkdownDocument document, MarkdownAsciiDocExportOptions? options = null, CancellationToken cancellationToken = default) #Converts asynchronously and returns the model and completed report.
Parameters
- document OfficeIMO.Markdown.MarkdownDocument
- options OfficeIMO.AsciiDoc.Markdown.MarkdownAsciiDocExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionResult<AsciiDocDocument>>public static MarkdownDocument ToMarkdown(AsciiDocDocument document, AsciiDocMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #Converts into a detached Markdown model.
Parameters
- document OfficeIMO.AsciiDoc.AsciiDocDocument
- options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
MarkdownDocumentpublic static MarkdownDocument ToMarkdown(AsciiDocDocument document, AsciiDocMarkdownExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #Converts and retains native diagnostic locations and canonical source evidence.
Parameters
- document OfficeIMO.AsciiDoc.AsciiDocDocument
- options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
MarkdownDocumentpublic static MarkdownDocument ToMarkdown(AsciiDocBlock block, AsciiDocDocumentAttributes attributes, AsciiDocMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #Converts a single block using the attributes and reference catalog in effect at that block.
Parameters
- block OfficeIMO.AsciiDoc.AsciiDocBlock
- attributes OfficeIMO.AsciiDoc.AsciiDocDocumentAttributes
- options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
MarkdownDocumentpublic static MarkdownDocument ToMarkdown(AsciiDocBlock block, AsciiDocDocumentAttributes attributes, AsciiDocMarkdownExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #Converts a contextual block while retaining its diagnostics and used footnotes.
Parameters
- block OfficeIMO.AsciiDoc.AsciiDocBlock
- attributes OfficeIMO.AsciiDoc.AsciiDocDocumentAttributes
- options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
MarkdownDocumentpublic static Task<OfficeConversionResult<MarkdownDocument>> ToMarkdownAsync(AsciiDocDocument document, AsciiDocMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #Converts asynchronously and returns the model and completed report.
Parameters
- document OfficeIMO.AsciiDoc.AsciiDocDocument
- options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionResult<MarkdownDocument>>