Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@hesto2/md-to-adf

Package Overview
Dependencies
Maintainers
0
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@hesto2/md-to-adf

Translate Markdown (Github) into Atlassian Document Format (ADF)

  • 0.1.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
2
increased by100%
Maintainers
0
Weekly downloads
 
Created
Source

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

Keywords

FAQs

Package last updated on 15 Oct 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc