Atlassian Document Formatter icon

Atlassian Document Formatter

Converts to and from Atlassian Document Format (ADF)
Join our community

Overview

This node converts data between Atlassian Document Format (ADF) and other markup formats such as Wiki Markup and Markdown. It supports three main conversion modes:

  • Wiki Markup to ADF
  • ADF to Wiki Markup
  • Markdown to ADF

Such conversions are useful when integrating content from different sources or editors that use these formats, enabling seamless transformation for further processing or display in Atlassian products.

Practical examples:

  • Converting legacy Wiki Markup content into ADF for use in modern Atlassian tools.
  • Exporting ADF content back to Wiki Markup for compatibility with older systems.
  • Importing Markdown documents and converting them into ADF for rich editing or storage.

Properties

Name Meaning
Mode Conversion mode to apply. Options: "Wiki Markup to ADF", "ADF to Wiki Markup", "Markdown to ADF"
Input Data The source data to convert. For Wiki Markup and Markdown modes, this is a string; for ADF input, JSON is accepted.
Destination Key The name of the output field where the converted result will be stored in the output JSON.
Include Other Input Fields Whether to include all original input fields alongside the converted output in the node's result.

Output

The node outputs an array of items, each containing a json object. This object includes:

  • The converted data under the key specified by the Destination Key property.
    • For conversions producing ADF, the output is a JSON string representing the Atlassian Document Format.
    • For conversions producing Wiki Markup, the output is a string in Wiki Markup format.

If Include Other Input Fields is enabled, all original input fields are preserved alongside the converted data.

No binary data output is produced by this node.

Dependencies

  • Uses external libraries for parsing and encoding:
    • @atlaskit/editor-wikimarkup-transformer for Wiki Markup <-> ADF transformations.
    • @atlaskit/editor-markdown-transformer for Markdown -> ADF conversion.
    • @atlaskit/editor-json-transformer for handling ADF JSON parsing.

No special API keys or credentials are required.

Troubleshooting

  • Input Data type mismatch:
    When converting from Wiki Markup to ADF, the input must be a string. Providing JSON or other types will cause an error. Ensure the input matches the expected format for the selected mode.

  • Invalid JSON input:
    For ADF to Wiki Markup conversion, if the input is a string, it attempts to parse it as JSON. Malformed JSON will cause parsing errors. Validate JSON input before running the node.

  • Conversion errors:
    Errors thrown during parsing or encoding are caught per item. If "Continue On Fail" is disabled, the node stops on the first error. Enabling "Continue On Fail" allows processing remaining items while reporting errors in the output.

Links and References

Discussion