AdfToMarkdown Class

Namespace: Meziantou.Framework.AtlassianDataFormat
Assembly: Meziantou.Framework.AtlassianDataFormat.dll
Package: Meziantou.Framework.AtlassianDataFormat 1.0.4
Source: AdfToMarkdown.cs
Available in package assets: net10.0net11.0

Converts Atlassian Document Format documents to Markdown.

public static class AdfToMarkdown

Methods

Name	Description
Convert(AdfDocument)	Converts an ADF document to Markdown using the default options.
Convert(AdfDocument, AdfToMarkdownOptions)	Converts an ADF document to Markdown.
Convert(string)	Converts an ADF document to Markdown using the default options.
Convert(string, AdfToMarkdownOptions)	Converts an ADF document to Markdown.
Convert(JsonElement)	Converts an ADF document to Markdown using the default options.
Convert(JsonElement, AdfToMarkdownOptions)	Converts an ADF document to Markdown.
Convert(JsonNode)	Converts an ADF document to Markdown using the default options.
Convert(JsonNode, AdfToMarkdownOptions)	Converts an ADF document to Markdown.

Convert overloads

Convert(AdfDocument)

AdfToMarkdown.cs

Converts an ADF document to Markdown using the default options.

public static string Convert(AdfDocument document)

Parameters

document AdfDocument: The document to convert.

Returns

string

Convert(AdfDocument, AdfToMarkdownOptions)

AdfToMarkdown.cs

Converts an ADF document to Markdown.

public static string Convert(AdfDocument document, AdfToMarkdownOptions options)

Parameters

document AdfDocument: The document to convert.
options AdfToMarkdownOptions: The conversion options.

Returns

string

Convert(string)

AdfToMarkdown.cs

Converts an ADF document to Markdown using the default options.

public static string Convert(string json)

Parameters

json string: The JSON representation of the document.

Returns

string

Exceptions

AdfException: The value is not a valid ADF document.

Convert(string, AdfToMarkdownOptions)

AdfToMarkdown.cs

Converts an ADF document to Markdown.

public static string Convert(string json, AdfToMarkdownOptions options)

Parameters

json string: The JSON representation of the document.
options AdfToMarkdownOptions: The conversion options.

Returns

string

Exceptions

AdfException: The value is not a valid ADF document.

Convert(JsonElement)

AdfToMarkdown.cs

Converts an ADF document to Markdown using the default options.

public static string Convert(JsonElement element)

Parameters

element JsonElement: The JSON representation of the document.

Returns

string

Exceptions

AdfException: The value is not a valid ADF document.

Convert(JsonElement, AdfToMarkdownOptions)

AdfToMarkdown.cs

Converts an ADF document to Markdown.

public static string Convert(JsonElement element, AdfToMarkdownOptions options)

Parameters

element JsonElement: The JSON representation of the document.
options AdfToMarkdownOptions: The conversion options.

Returns

string

Exceptions

AdfException: The value is not a valid ADF document.

Convert(JsonNode)

AdfToMarkdown.cs

Converts an ADF document to Markdown using the default options.

public static string Convert(JsonNode node)

Parameters

node JsonNode: The JSON representation of the document.

Returns

string

Exceptions

AdfException: The value is not a valid ADF document.

Convert(JsonNode, AdfToMarkdownOptions)

AdfToMarkdown.cs

Converts an ADF document to Markdown.

public static string Convert(JsonNode node, AdfToMarkdownOptions options)

Parameters

node JsonNode: The JSON representation of the document.
options AdfToMarkdownOptions: The conversion options.

Returns

string

Exceptions

AdfException: The value is not a valid ADF document.