Installation

Release binaries

Download a binary from the releases page:

Put the adoctra binary on your PATH and check it:

adoctra --version

From crates.io

With Rust 1.94 or newer (install it with rustup):

cargo install adoctra-cli     # installs the `adoctra` command

From source

git clone https://github.com/avskor/adoctra
cd adoctra
cargo install --path crates/adoctra-cli

First conversion

Create hello.adoc:

= Hello, adoctra
:toc:

== Section

A paragraph with *bold* and _italic_ text.

[source,rust]
----
fn main() {
    println!("Hello");
}
----

Convert it:

adoctra -a source-highlighter=rouge hello.adoc   # writes hello.html

Open hello.html in a browser. Or skip the installation and paste the document into the playground.

Optional tools

Most features need nothing else. Diagrams run their own programs (dot, mmdc, plantuml, d2, …) unless you render them through a server; see Diagrams.