html2adf

Table of Contents

• About
• Getting Started
• Usage
• Contributing

About

This is a console application that converts HTML to Atlassian Document Format (ADF) using the Atlassian Atlaskit modules.

Getting Started

These instructions will get you a copy of the project up and running on your local machine.

Prerequisites

Please note that you need to have Node.js and npm installed on your machine to run this program. If you don't have them installed, you can download them from the official Node.js website.

Installing

To install this program, you would typically follow these steps:

Install the CLI program globally: This will make it callable from any location on your system.

npm -g install html2adf-node

Usage

html2adf item "<h1>This is where you put your HTML Input</h1>"

html2adf help
Usage: command [options] [command]

Options:
  -h, --help      Display help for command

Commands:
  item <ITEM>     Converts HTML to Atlassian Document Format (ADF).
  help [command]  display help for command

Examples:
  $ html2adf help
  $ html2adf item --help
  $ html2adf item "<h1>HTML text input</h1>"
  $ html2adf item "<h1>HTML text input</h1>" > output.json

HTML Formatting Requirements

As this is a terminal program, the HTML input will need to be formatted specifically. Most issues have been picked up in the function, but please note the following requirements:

1. Pass the string inside double quotations:

Correct handling:

$ html2adf item "<h1>HTML text input</h1>"

2. Internal quotations should be single only:

Correct handling:

$ html2adf item "<p><b>Google:</b><a target='_blank' href='https://www.google.com'>Google</a></p>"