Markdown to Atlassian Document Format (ADF) translation
Transform Github Markdown text into Atlassian Document Format (ADF)*
* ADF is JIRA and Confluence to describe complex formatted text.
When bridging tools between Github, Wikipedia and other Markdown-based wiki or document system, there's no tool to convert the formatted text into the equivalent syntax in JIRA or Confluence. This library does exactly that. It allows you to take any markdown (Github focussed for now) and translate it into a JIRA/Confluence compatible ADF document.
While writing a Github Action to push Github Issues into JIRA Subtask, we ended up stuck unable to pass complex formatting from the issue into JIRA, which rendered the interest of the tools much lower. That's why we embarked on translating Github Markdown into a syntaxically correct ADF document.
Install Markdown To ADF
npm install md-to-adf
Import/require the translate function:
As a require
const fnTranslate = require( 'md-to-adf' )
As a module
import fnTranslate from 'md-to-adf'
Pass it the Markdown (Github) formatted text and get the full ADF Document returned
const translatedADF = fnTranslate( myJIRAFormattedTextContent )
// * JSDoc