Neoanthropic Preternatural Murmurings

    md-to-adf-dailykos

    0.1.1 • Public • Published

    Markdown to Atlassian Document Format (ADF) translation

    Transform Github Markdown text into Atlassian Document Format (ADF)*

    CI Codecov Published

    npm downloads npm latest

    * ADF is JIRA and Confluence to describe complex formatted text.

    Overview

    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.

    Motivation

    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.

    Getting Started

    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 )

    You're done!

    Additional Documentation

    // * JSDoc

    Install

    npm i md-to-adf-dailykos

    DownloadsWeekly Downloads

    83

    Version

    0.1.1

    License

    Apache-2.0

    Unpacked Size

    779 kB

    Total Files

    50

    Last publish

    Collaborators

    • yiwen74