AsciiDoc Modules for Office-stamper

Introduction

This project provides a suite of modules for handling AsciiDoc content within the Office-stamper ecosystem. It enables bidirectional conversion between AsciiDoc and DOCX, as well as high-quality rendering to HTML, SVG, and PNG.

It is designed to be used as a set of libraries to integrate AsciiDoc processing into Java applications, especially those using Office-stamper for document generation.

Key Features

• Bidirectional DOCX Conversion: Convert AsciiDoc to DOCX and vice versa (with support for AlternateContent and pict elements).
• Lightweight Rendering: Render AsciiDoc to HTML, SVG, and Text without needing a full Asciidoctor installation.
• Compiler API: High-level API for complex conversion tasks and PNG export.
• Documentation Previews: AsciidoctorJ extension for embedding previews in your own documentation.
• Modular Architecture: Use only the components you need (requires Java 25).
• Rich Iconography: Built-in support for SVG icons.

Modules

This repository is structured into several modules:

• Core – Foundation data model and parsing logic.
• Converters – Lightweight rendering to HTML, SVG, and Text.
• DOCX – Conversion between AsciiDoc and Microsoft Word (DOCX).
• Compiler – High-level API and PNG export utilities.
• Preview – AsciidoctorJ extension for embedding previews.

Architecture

graph TD
    subgraph AsciiDoc Parent
        core[asciidoc-core]
        conv[asciidoc-converters]
        docx[asciidoc-docx]
        comp[asciidoc-compiler]
        ext[asciidoc-preview]
    end

    conv --> core
    docx --> core
    comp --> core
    comp --> conv
    comp --> docx
    ext --> comp

Documentation

A comprehensive documentation is available at https://asciidoc.verron.pro.

Author

Joseph Verron - About Me

License

MIT License