webware/asciidoc-php is a PHP port of the Asciidoctor toolchain that converts
AsciiDoc source files to HTML5. The package namespace is Webware\AsciidocPhp.
It follows https://asciidoctor.org/[Asciidoctor] as its reference implementation and targets documentation-quality feature coverage rather than 1:1 API compatibility with Asciidoctor. It is not affiliated with, sponsored by, or endorsed by the Asciidoctor project.
Requirements
-
PHP 8.4 or PHP 8.5, with the CLI SAPI available as
php -
Composer, to install the package and its autoloader
-
No PHP runtime dependencies beyond PHP itself
Installation
Install with Composer:
composer require webware/asciidoc-phpThe command line entry point is installed as vendor/bin/asciidoc-php. When
working from a git clone, run php bin/asciidoc-php instead.
Quick start
Convert a single file, writing the HTML next to the source:
vendor/bin/asciidoc-php docs/guide.adocConvert to a specific output file:
vendor/bin/asciidoc-php docs/guide.adoc -o build/guide.htmlThe same conversion is available from PHP through the facade:
use Webware\AsciidocPhp\Asciidoc;
$html = Asciidoc::convert('= Hello World');
$html = Asciidoc::convertFile('/path/to/guide.adoc', [
'attributes' => ['toc' => 'left', 'sectnums' => ''],
]);