Html-to-jira NPM

Html-To-JIRA Converter

Description

Html-To-JIRA Converter is a TypeScript library designed to convert HTML content into a JIRA-compatible format. This library is particularly useful for creating Jira issues.

Installation

To install Html-To-JIRA Converter, you can use npm with the following command:

npm install html-to-jira

Quickstart

To use the Html-To-JIRA Converter, first import the HtmlToJsonConverter class:

import { HtmlToJsonConverter } from "html-to-jira";

Then, instantiate the class with an HTML document and call the convert method:

import { JSDOM } from "jsdom";

const htmlDocument = new JSDOM(`Your HTML Content`);
const converter = new HtmlToJsonConverter(htmlDocument);
const jiraFormattedContent = converter.convert();

Example

const converter = new HtmlToJsonConverter(
    new JSDOM("<h1>I'm a heading level one</h1>")
);
const jiraFormattedContent = converter.convert();

// [{
//    "type": "heading",
//    "attrs": {
//        "level": level
//    },
//    "content": [
//        {
//            "type": "text",
//            "text": `I'm a heading level one`
//        }
//    ]
// }]