Getting Started

This guide gets asciidoc-core working in a project: add the dependency, build from source, and run your first parse.

Prerequisites

A JDK matching the project baseline: Java 25 (set via maven.compiler.release).
Apache Maven 3.9+ (or the project’s Maven wrapper, if present).

Add the dependency

<dependency>
    <groupId>pro.verron.asciidoc</groupId>
    <artifactId>asciidoc-core</artifactId>
    <version>${project.version}</version>
</dependency>

Build from source

git clone https://github.com/verronpro/asciidoc.git
cd asciidoc/asciidoc-core
mvn install

This installs the artifact into your local repository so other modules can depend on it.

Parse your first document

import pro.verron.asciidoc.core.AsciiDocParser;
import pro.verron.asciidoc.core.AsciiDocModel;

AsciiDocParser parser = new AsciiDocParser();
AsciiDocModel model = parser.parse("Some *bold* text");

// Inspect the structured model: comments, document parts, inline markup, …

Where to go next

Features — the data model and parser capabilities in detail.
Overview — the module README and links to the full documentation.

Edit this page