https://github.com/b-yond-infinite-network/md-to-adf

Markdown to Atlassian Document Format translation/traduction
https://github.com/b-yond-infinite-network/md-to-adf

adf confluence jira markdown markdown-to-adf markdown-to-confluence markdown-to-jira

Last synced: about 2 months ago
JSON representation

Markdown to Atlassian Document Format translation/traduction

• Host: GitHub
• URL: https://github.com/b-yond-infinite-network/md-to-adf
• Owner: b-yond-infinite-network
• License: apache-2.0
• Created: 2020-01-28T03:08:50.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T05:56:43.000Z (over 1 year ago)
• Last Synced: 2024-04-24T16:18:52.455Z (5 months ago)
• Topics: adf, confluence, jira, markdown, markdown-to-adf, markdown-to-confluence, markdown-to-jira
• Language: Gherkin
• Size: 2.36 MB
• Stars: 39
• Watchers: 5
• Forks: 4
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Markdown to Atlassian Document Format (ADF) translation

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

[![CI](https://github.com/b-yond-infinite-network/md-to-adf/workflows/Integration/badge.svg?branch=master)](https://github.com/b-yond-infinite-network/md-to-adf/actions?query=workflow%3AIntegration)

[![Codecov](https://codecov.io/gh/b-yond-infinite-network/md-to-adf/branch/master/graph/badge.svg)](https://codecov.io/gh/b-yond-infinite-network/md-to-adf)

[![Published](https://github.com/b-yond-infinite-network/md-to-adf/workflows/Publish/badge.svg?branch=master)](https://github.com/b-yond-infinite-network/md-to-adf/actions?query=workflow%3APublish)

[![npm downloads](https://img.shields.io/npm/dm/md-to-adf?style=flat-square)](https://www.npmjs.com/package/md-to-adf)

[![npm latest](https://img.shields.io/npm/v/md-to-adf/latest.svg)](https://www.npmjs.com/package/md-to-adf)

\* 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

  ```javascript

  const fnTranslate    = require( 'md-to-adf' )

  ```

  

* As a module

  ```javascript

  import fnTranslate from 'md-to-adf'

  ```

  

  

### Pass it the Markdown (Github) formatted text and get the full ADF Document returned

```javascript

const translatedADF = fnTranslate( myJIRAFormattedTextContent )

```

### You're done!

## Additional Documentation 

//  * [JSDoc](https://b-yond-infinite-network.github.io/md-to-adf/md-to-adf/0.0.0-semantically-released/)