AdfKit

AdfKit is a powerful .NET library for converting HTML to Atlassian Document Format (ADF). Perfect for integrating rich content into Confluence, Jira, and other Atlassian products with precise formatting preservation.

Features

High-Fidelity Conversion: Convert HTML to ADF with excellent formatting preservation
Multi-Target Support: Compatible with .NET 6, .NET 8, and .NET 9
Comprehensive HTML Support: Handles headings, paragraphs, lists, tables, links, images, and inline formatting
Production-Ready: Built for enterprise use with robust error handling and validation
Easy Integration: Simple API with both instance and static methods
Secure Licensing: Cryptographically signed license validation

Installation

Install AdfKit via NuGet Package Manager:

dotnet add package AdfKit

Or via Package Manager Console in Visual Studio:

Install-Package AdfKit

License Requirement

** Important: AdfKit requires a valid license key to operate without restrictions.**

Get Your License Key

** Free Trial**: Request a free trial license - No credit card required
** Commercial License**: Purchase a license for production use
** Enterprise**: Contact us for volume licensing and custom terms

Trial Limitations

The trial license includes:

Full functionality for evaluation
14-day trial period
Up to 100 conversions
Not for production use

Quick Start

1. Set up your license

# Option 1: Environment variable (recommended)
export ADFKIT_LICENSE_FILE="/path/to/your/license.key"

# Option 2: License content directly
export ADFKIT_LICENSE_CONTENT="your-license-key-content"

2. Convert HTML to ADF

using AdfKit;
using AdfKit.Licensing;

try
{
    // Create converter (license loaded from environment)
    var converter = new HtmlToAdfConverter();
    
    // Convert HTML to ADF
    var html = """
        <h1>Welcome to AdfKit</h1>
        <p>This is a <strong>powerful</strong> HTML to ADF converter.</p>
        <ul>
            <li>Easy to use</li>
            <li>High performance</li>
            <li>Production ready</li>
        </ul>
        """;
    
    var adfDocument = converter.ConvertHtml(html);
    
    // Use the ADF document with Atlassian APIs
    Console.WriteLine($" Conversion successful! Licensed to: {converter.LicenseData.User}");
}
catch (LicenseValidationException ex)
{
    Console.WriteLine($" License error: {ex.Message}");
}

Usage Examples

Static Method (One-liner)

using AdfKit;

// Convert with license file path
var adfDoc = HtmlToAdfConverter.Convert(htmlContent, "./license.key");

Instance with License File

using AdfKit;

// Pass license file directly to constructor
var converter = new HtmlToAdfConverter("./license.key");
var adfDocument = converter.ConvertHtml(htmlContent);

// Access license information
var license = converter.LicenseData;
Console.WriteLine($"Licensed to: {license.User}");
Console.WriteLine($"Expires: {license.ExpiresAt.ToString("yyyy-MM-dd")  "Never"}");

ASP.NET Core Integration

// In Program.cs or Startup.cs
builder.Services.AddScoped<HtmlToAdfConverter>(provider =>
{
    var config = provider.GetRequiredService<IConfiguration>();
    var licensePath = config["AdfKit:LicensePath"];
    return new HtmlToAdfConverter(licensePath);
});

// In your controller or service
public class DocumentController : ControllerBase
{
    private readonly HtmlToAdfConverter _converter;
    
    public DocumentController(HtmlToAdfConverter converter)
    {
        _converter = converter;
    }
    
    [HttpPost("convert")]
    public IActionResult ConvertToAdf([FromBody] string html)
    {
        try
        {
            var adf = _converter.ConvertHtml(html);
            return Ok(adf);
        }
        catch (LicenseValidationException ex)
        {
            return BadRequest($"License error: {ex.Message}");
        }
    }
}

Supported HTML Elements

Element	Support	Notes
Headers		`<h1>` through `<h6>`
Paragraphs		`<p>` with inline formatting
Lists		Ordered (`<ol>`) and unordered (`<ul>`)
Tables		Basic tables with headers and cells
Links		`<a href="">` elements
Images		`<img>` converted to media elements
Formatting		Bold, italic, underline, strikethrough
Code		Inline `<code>` and `<pre>` blocks
Blockquotes		`<blockquote>` elements
Line Breaks		`<br>` and `<hr>` elements

Configuration

License Setup Options

// 1. Environment variable (recommended for production)
Environment.SetEnvironmentVariable("ADFKIT_LICENSE_FILE", "./license.key");
var converter = new HtmlToAdfConverter();

// 2. Direct file path
var converter = new HtmlToAdfConverter("./license.key");

// 3. License content as environment variable
Environment.SetEnvironmentVariable("ADFKIT_LICENSE_CONTENT", licenseContent);
var converter = new HtmlToAdfConverter();

Error Handling

using AdfKit;
using AdfKit.Licensing;

try
{
    var converter = new HtmlToAdfConverter("./license.key");
    var result = converter.ConvertHtml(html);
}
catch (LicenseValidationException ex) when (ex.Message.Contains("expired"))
{
    // Handle expired license
    Console.WriteLine("License has expired. Please renew your license.");
}
catch (LicenseValidationException ex) when (ex.Message.Contains("not found"))
{
    // Handle missing license
    Console.WriteLine("License file not found. Please check the file path.");
}
catch (LicenseValidationException ex)
{
    // Handle other license issues
    Console.WriteLine($"License validation failed: {ex.Message}");
}

License Features

Perpetual License: Continue using the version you licensed forever
One Year Updates: Free updates and support for 12 months
No Runtime Royalties: No additional fees based on usage
Cryptographic Security: Tamper-proof license validation

Support & Resources

** Documentation**: https://adfapi.dev/docs
** Free Trial**: https://adfapi.dev/trial
** Pricing**: https://adfapi.dev/pricing
** Support**: support@adfapi.dev
** Issues**: Report Issues

What is ADF

Atlassian Document Format (ADF) is a JSON-based format used by Atlassian products like Confluence and Jira to represent rich content. It's the standard format for:

Creating Confluence pages programmatically
Adding rich content to Jira issues
Integrating with Atlassian's Editor

AdfKit makes it easy to convert your existing HTML content into ADF format with high fidelity.

Important Notes

License Required: A valid license key is required for production use
Trial Available: Free trial licenses available for evaluation
No Storage: AdfKit doesn't store or transmit your content
Offline Processing: All conversion happens locally on your machine
Thread Safe: Converter instances are thread-safe for concurrent use

Ready to get started Get your free trial license and start converting HTML to ADF in minutes!

AdfKit

Features

High-Fidelity Conversion: Convert HTML to ADF with excellent formatting preservation
Multi-Target Support: Compatible with .NET 6, .NET 8, and .NET 9
Comprehensive HTML Support: Handles headings, paragraphs, lists, tables, links, images, and inline formatting
Production-Ready: Built for enterprise use with robust error handling and validation
Easy Integration: Simple API with both instance and static methods
Secure Licensing: Cryptographically signed license validation

Installation

Install AdfKit via NuGet Package Manager:

dotnet add package AdfKit

Or via Package Manager Console in Visual Studio:

Install-Package AdfKit

License Requirement

** Important: AdfKit requires a valid license key to operate without restrictions.**

Get Your License Key

** Free Trial**: Request a free trial license - No credit card required
** Commercial License**: Purchase a license for production use
** Enterprise**: Contact us for volume licensing and custom terms

Trial Limitations

The trial license includes:

Full functionality for evaluation
14-day trial period
Up to 100 conversions
Not for production use

Quick Start

1. Set up your license

# Option 1: Environment variable (recommended)
export ADFKIT_LICENSE_FILE="/path/to/your/license.key"

# Option 2: License content directly
export ADFKIT_LICENSE_CONTENT="your-license-key-content"

2. Convert HTML to ADF

using AdfKit;
using AdfKit.Licensing;

try
{
    // Create converter (license loaded from environment)
    var converter = new HtmlToAdfConverter();
    
    // Convert HTML to ADF
    var html = """
        <h1>Welcome to AdfKit</h1>
        <p>This is a <strong>powerful</strong> HTML to ADF converter.</p>
        <ul>
            <li>Easy to use</li>
            <li>High performance</li>
            <li>Production ready</li>
        </ul>
        """;
    
    var adfDocument = converter.ConvertHtml(html);
    
    // Use the ADF document with Atlassian APIs
    Console.WriteLine($" Conversion successful! Licensed to: {converter.LicenseData.User}");
}
catch (LicenseValidationException ex)
{
    Console.WriteLine($" License error: {ex.Message}");
}

Usage Examples

Static Method (One-liner)

using AdfKit;

// Convert with license file path
var adfDoc = HtmlToAdfConverter.Convert(htmlContent, "./license.key");

Instance with License File

using AdfKit;

// Pass license file directly to constructor
var converter = new HtmlToAdfConverter("./license.key");
var adfDocument = converter.ConvertHtml(htmlContent);

// Access license information
var license = converter.LicenseData;
Console.WriteLine($"Licensed to: {license.User}");
Console.WriteLine($"Expires: {license.ExpiresAt.ToString("yyyy-MM-dd")  "Never"}");

ASP.NET Core Integration

// In Program.cs or Startup.cs
builder.Services.AddScoped<HtmlToAdfConverter>(provider =>
{
    var config = provider.GetRequiredService<IConfiguration>();
    var licensePath = config["AdfKit:LicensePath"];
    return new HtmlToAdfConverter(licensePath);
});

// In your controller or service
public class DocumentController : ControllerBase
{
    private readonly HtmlToAdfConverter _converter;
    
    public DocumentController(HtmlToAdfConverter converter)
    {
        _converter = converter;
    }
    
    [HttpPost("convert")]
    public IActionResult ConvertToAdf([FromBody] string html)
    {
        try
        {
            var adf = _converter.ConvertHtml(html);
            return Ok(adf);
        }
        catch (LicenseValidationException ex)
        {
            return BadRequest($"License error: {ex.Message}");
        }
    }
}

Supported HTML Elements

Element	Support	Notes
Headers		`<h1>` through `<h6>`
Paragraphs		`<p>` with inline formatting
Lists		Ordered (`<ol>`) and unordered (`<ul>`)
Tables		Basic tables with headers and cells
Links		`<a href="">` elements
Images		`<img>` converted to media elements
Formatting		Bold, italic, underline, strikethrough
Code		Inline `<code>` and `<pre>` blocks
Blockquotes		`<blockquote>` elements
Line Breaks		`<br>` and `<hr>` elements

Configuration

License Setup Options

// 1. Environment variable (recommended for production)
Environment.SetEnvironmentVariable("ADFKIT_LICENSE_FILE", "./license.key");
var converter = new HtmlToAdfConverter();

// 2. Direct file path
var converter = new HtmlToAdfConverter("./license.key");

// 3. License content as environment variable
Environment.SetEnvironmentVariable("ADFKIT_LICENSE_CONTENT", licenseContent);
var converter = new HtmlToAdfConverter();

Error Handling

using AdfKit;
using AdfKit.Licensing;

try
{
    var converter = new HtmlToAdfConverter("./license.key");
    var result = converter.ConvertHtml(html);
}
catch (LicenseValidationException ex) when (ex.Message.Contains("expired"))
{
    // Handle expired license
    Console.WriteLine("License has expired. Please renew your license.");
}
catch (LicenseValidationException ex) when (ex.Message.Contains("not found"))
{
    // Handle missing license
    Console.WriteLine("License file not found. Please check the file path.");
}
catch (LicenseValidationException ex)
{
    // Handle other license issues
    Console.WriteLine($"License validation failed: {ex.Message}");
}

License Features

Perpetual License: Continue using the version you licensed forever
One Year Updates: Free updates and support for 12 months
No Runtime Royalties: No additional fees based on usage
Cryptographic Security: Tamper-proof license validation

Support & Resources

** Documentation**: https://adfapi.dev/docs
** Free Trial**: https://adfapi.dev/trial
** Pricing**: https://adfapi.dev/pricing
** Support**: support@adfapi.dev
** Issues**: Report Issues

What is ADF

Atlassian Document Format (ADF) is a JSON-based format used by Atlassian products like Confluence and Jira to represent rich content. It's the standard format for:

Creating Confluence pages programmatically
Adding rich content to Jira issues
Integrating with Atlassian's Editor

AdfKit makes it easy to convert your existing HTML content into ADF format with high fidelity.

Important Notes

License Required: A valid license key is required for production use
Trial Available: Free trial licenses available for evaluation
No Storage: AdfKit doesn't store or transmit your content
Offline Processing: All conversion happens locally on your machine
Thread Safe: Converter instances are thread-safe for concurrent use

Ready to get started Get your free trial license and start converting HTML to ADF in minutes!

quaerens/AdfKitv1.0.1122

Get Started

Readme

AdfKit

Features

Installation

License Requirement

Get Your License Key

Trial Limitations

Quick Start

1. Set up your license

2. Convert HTML to ADF

Usage Examples

Static Method (One-liner)

Instance with License File

ASP.NET Core Integration

Supported HTML Elements

Configuration

License Setup Options

Error Handling

License Features

Related Products

Support & Resources

What is ADF

Important Notes

quaerens/AdfKitv1.0.1122

Get Started

Readme

AdfKit

Features

Installation

License Requirement

Get Your License Key

Trial Limitations

Quick Start

1. Set up your license

2. Convert HTML to ADF

Usage Examples

Static Method (One-liner)

Instance with License File

ASP.NET Core Integration

Supported HTML Elements

Configuration

License Setup Options

Error Handling

License Features

Related Products

Support & Resources

What is ADF

Important Notes