mdast-util-from-adf

mdast utility to convert ADF.

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

npm:

1npm install mdast-util-from-adf

Use

Say we have the following script, example.js:

1import { fromADF } from "mdast-util-from-adf";
2import { toMarkdown } from "mdast-util-to-markdown";
3
4const doc = {
5  version: 1,
6  type: "doc",
7  content: [
8    {
9      type: "paragraph",
10      content: [
11        {
12          type: "text",
13          text: "Hello ",
14        },
15        {
16          type: "text",
17          text: "ADF",
18          marks: [
19            {
20              type: "link",
21              attrs: {
22                href: "https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/",
23              },
24            },
25            {
26              type: "strong",
27            },
28          ],
29        },
30        {
31          type: "text",
32          text: "!",
33        },
34      ],
35    },
36  ],
37};
38
39console.log(toMarkdown(fromADF(doc)));

Now, running node example yields:

1Hello **[ADF](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)**!

References

• Atlassian Document Format: https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/
• ADF Builder: https://developer.atlassian.com/cloud/jira/platform/apis/document/playground/
• ADF Viewer: https://developer.atlassian.com/cloud/jira/platform/apis/document/viewer/