# AsciiDocMarkdownConverterExtensions

Loss-aware conversions between AsciiDoc and Markdown models.

Class 

`OfficeIMO.AsciiDoc.Markdown`

**Namespace**

`OfficeIMO.AsciiDoc.Markdown`

**Assembly**

`OfficeIMO.AsciiDoc.Markdown`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[AsciiDocMarkdownConverterExtensions.cs:9](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc.Markdown/AsciiDocMarkdownConverterExtensions.cs#L9)

**Modifiers**

static

Loss-aware conversions between AsciiDoc and Markdown models.

## Inheritance

- object
- AsciiDocMarkdownConverterExtensions

Filter members 

Show inherited

## Methods

SaveAsAsciiDoc 2 overloads

`public static OfficeConversionReport SaveAsAsciiDoc(MarkdownDocument document, string path, MarkdownAsciiDocExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasasciidoc-officeimo-markdown-markdowndocument-string-officeimo-asciidoc-markdown-markdownasciidocexportoptions-threading-cancellationtoken)

[AsciiDocMarkdownConverterExtensions.cs:80](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc.Markdown/AsciiDocMarkdownConverterExtensions.cs#L80)

Writes converted AsciiDoc and returns the report, including native evidence.

Parameters

**document OfficeIMO.Markdown.MarkdownDocument required**

**path string required**

**options OfficeIMO.AsciiDoc.Markdown.MarkdownAsciiDocExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsAsciiDoc(MarkdownDocument document, Stream stream, MarkdownAsciiDocExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasasciidoc-officeimo-markdown-markdowndocument-io-stream-officeimo-asciidoc-markdown-markdownasciidocexportoptions-threading-cancellationtoken)

[AsciiDocMarkdownConverterExtensions.cs:88](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc.Markdown/AsciiDocMarkdownConverterExtensions.cs#L88)

Writes converted AsciiDoc and returns the report, including native evidence.

Parameters

**document OfficeIMO.Markdown.MarkdownDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.AsciiDoc.Markdown.MarkdownAsciiDocExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`OfficeConversionReport`

SaveAsAsciiDocAsync 2 overloads

`public static async Task<OfficeConversionReport> SaveAsAsciiDocAsync(MarkdownDocument document, string path, MarkdownAsciiDocExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasasciidocasync-officeimo-markdown-markdowndocument-string-officeimo-asciidoc-markdown-markdownasciidocexportoptions-threading-cancellationtoken)

Asynchronously writes converted AsciiDoc and returns the report, including native evidence.

Parameters

**document OfficeIMO.Markdown.MarkdownDocument required**

**path string required**

**options OfficeIMO.AsciiDoc.Markdown.MarkdownAsciiDocExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsAsciiDocAsync(MarkdownDocument document, Stream stream, MarkdownAsciiDocExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasasciidocasync-officeimo-markdown-markdowndocument-io-stream-officeimo-asciidoc-markdown-markdownasciidocexportoptions-threading-cancellationtoken)

Asynchronously writes converted AsciiDoc and returns the report, including native evidence.

Parameters

**document OfficeIMO.Markdown.MarkdownDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.AsciiDoc.Markdown.MarkdownAsciiDocExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<OfficeConversionReport>`

SaveAsMarkdown 2 overloads

`public static OfficeConversionReport SaveAsMarkdown(AsciiDocDocument document, string path, AsciiDocMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdown-officeimo-asciidoc-asciidocdocument-string-officeimo-asciidoc-markdown-asciidocmarkdownexportoptions-threading-cancellationtoken)

[AsciiDocMarkdownConverterExtensions.cs:28](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc.Markdown/AsciiDocMarkdownConverterExtensions.cs#L28)

Writes converted Markdown and returns the report, including native evidence.

Parameters

**document OfficeIMO.AsciiDoc.AsciiDocDocument required**

**path string required**

**options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsMarkdown(AsciiDocDocument document, Stream stream, AsciiDocMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdown-officeimo-asciidoc-asciidocdocument-io-stream-officeimo-asciidoc-markdown-asciidocmarkdownexportoptions-threading-cancellationtoken)

[AsciiDocMarkdownConverterExtensions.cs:36](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc.Markdown/AsciiDocMarkdownConverterExtensions.cs#L36)

Writes converted Markdown and returns the report, including native evidence.

Parameters

**document OfficeIMO.AsciiDoc.AsciiDocDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`OfficeConversionReport`

SaveAsMarkdownAsync 2 overloads

`public static async Task<OfficeConversionReport> SaveAsMarkdownAsync(AsciiDocDocument document, string path, AsciiDocMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdownasync-officeimo-asciidoc-asciidocdocument-string-officeimo-asciidoc-markdown-asciidocmarkdownexportoptions-threading-cancellationtoken)

Asynchronously writes converted Markdown and returns the report, including native evidence.

Parameters

**document OfficeIMO.AsciiDoc.AsciiDocDocument required**

**path string required**

**options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsMarkdownAsync(AsciiDocDocument document, Stream stream, AsciiDocMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdownasync-officeimo-asciidoc-asciidocdocument-io-stream-officeimo-asciidoc-markdown-asciidocmarkdownexportoptions-threading-cancellationtoken)

Asynchronously writes converted Markdown and returns the report, including native evidence.

Parameters

**document OfficeIMO.AsciiDoc.AsciiDocDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<OfficeConversionReport>`

ToAsciiDoc 2 overloads

`public static AsciiDocDocument ToAsciiDoc(MarkdownDocument document, MarkdownAsciiDocExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-toasciidoc-officeimo-markdown-markdowndocument-officeimo-asciidoc-markdown-markdownasciidocexportoptions-threading-cancellationtoken)

[AsciiDocMarkdownConverterExtensions.cs:61](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc.Markdown/AsciiDocMarkdownConverterExtensions.cs#L61)

Converts into a detached AsciiDoc model.

Parameters

**document OfficeIMO.Markdown.MarkdownDocument required**

**options OfficeIMO.AsciiDoc.Markdown.MarkdownAsciiDocExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`AsciiDocDocument`

`public static AsciiDocDocument ToAsciiDoc(MarkdownDocument document, MarkdownAsciiDocExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#method-toasciidoc-officeimo-markdown-markdowndocument-officeimo-asciidoc-markdown-markdownasciidocexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[AsciiDocMarkdownConverterExtensions.cs:66](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc.Markdown/AsciiDocMarkdownConverterExtensions.cs#L66)

Converts and retains native diagnostic locations and canonical source evidence.

Parameters

**document OfficeIMO.Markdown.MarkdownDocument required**

**options OfficeIMO.AsciiDoc.Markdown.MarkdownAsciiDocExportOptions? required**

**report OfficeIMO.OfficeConversionReport required**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`AsciiDocDocument`

`public static Task<OfficeConversionResult<AsciiDocDocument>> ToAsciiDocAsync(MarkdownDocument document, MarkdownAsciiDocExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-toasciidocasync-officeimo-markdown-markdowndocument-officeimo-asciidoc-markdown-markdownasciidocexportoptions-threading-cancellationtoken)

[AsciiDocMarkdownConverterExtensions.cs:75](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc.Markdown/AsciiDocMarkdownConverterExtensions.cs#L75)

Converts asynchronously and returns the model and completed report.

Parameters

**document OfficeIMO.Markdown.MarkdownDocument required**

**options OfficeIMO.AsciiDoc.Markdown.MarkdownAsciiDocExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<OfficeConversionResult<AsciiDocDocument>>`

ToMarkdown 4 overloads

`public static MarkdownDocument ToMarkdown(AsciiDocDocument document, AsciiDocMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tomarkdown-officeimo-asciidoc-asciidocdocument-officeimo-asciidoc-markdown-asciidocmarkdownexportoptions-threading-cancellationtoken)

[AsciiDocMarkdownConverterExtensions.cs:9](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc.Markdown/AsciiDocMarkdownConverterExtensions.cs#L9)

Converts into a detached Markdown model.

Parameters

**document OfficeIMO.AsciiDoc.AsciiDocDocument required**

**options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`MarkdownDocument`

`public static MarkdownDocument ToMarkdown(AsciiDocDocument document, AsciiDocMarkdownExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#method-tomarkdown-officeimo-asciidoc-asciidocdocument-officeimo-asciidoc-markdown-asciidocmarkdownexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[AsciiDocMarkdownConverterExtensions.cs:14](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc.Markdown/AsciiDocMarkdownConverterExtensions.cs#L14)

Converts and retains native diagnostic locations and canonical source evidence.

Parameters

**document OfficeIMO.AsciiDoc.AsciiDocDocument required**

**options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? required**

**report OfficeIMO.OfficeConversionReport required**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`MarkdownDocument`

`public static MarkdownDocument ToMarkdown(AsciiDocBlock block, AsciiDocDocumentAttributes attributes, AsciiDocMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tomarkdown-officeimo-asciidoc-asciidocblock-officeimo-asciidoc-asciidocdocumentattributes-officeimo-asciidoc-markdown-asciidocmarkdownexportoptions-threading-cancellationtoken)

[AsciiDocMarkdownConverterExtensions.cs:114](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc.Markdown/AsciiDocMarkdownConverterExtensions.cs#L114)

Converts a single block using the attributes and reference catalog in effect at that block.

Parameters

**block OfficeIMO.AsciiDoc.AsciiDocBlock required**

**attributes OfficeIMO.AsciiDoc.AsciiDocDocumentAttributes required**

**options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`MarkdownDocument`

`public static MarkdownDocument ToMarkdown(AsciiDocBlock block, AsciiDocDocumentAttributes attributes, AsciiDocMarkdownExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#member-ff686a3589baa21a7c590544)

[AsciiDocMarkdownConverterExtensions.cs:119](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc.Markdown/AsciiDocMarkdownConverterExtensions.cs#L119)

Converts a contextual block while retaining its diagnostics and used footnotes.

Parameters

**block OfficeIMO.AsciiDoc.AsciiDocBlock required**

**attributes OfficeIMO.AsciiDoc.AsciiDocDocumentAttributes required**

**options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? required**

**report OfficeIMO.OfficeConversionReport required**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`MarkdownDocument`

`public static Task<OfficeConversionResult<MarkdownDocument>> ToMarkdownAsync(AsciiDocDocument document, AsciiDocMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tomarkdownasync-officeimo-asciidoc-asciidocdocument-officeimo-asciidoc-markdown-asciidocmarkdownexportoptions-threading-cancellationtoken)

[AsciiDocMarkdownConverterExtensions.cs:23](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AsciiDoc.Markdown/AsciiDocMarkdownConverterExtensions.cs#L23)

Converts asynchronously and returns the model and completed report.

Parameters

**document OfficeIMO.AsciiDoc.AsciiDocDocument required**

**options OfficeIMO.AsciiDoc.Markdown.AsciiDocMarkdownExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<OfficeConversionResult<MarkdownDocument>>`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

<!-- PowerForge markdown artifact sha256:F2768090FFDD49609620393DED7E6EC1ECFE5A2821AEC7FC14392566CC101065 -->
