---
name: "Text::Markup::Asciidoc"
section: "3pm"
platform: "linux"
package: "libtext-markup-perl"
version: "0.33-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Text::Markup::Asciidoc"
---

# Text::Markup::Asciidoc(3pm)

Asciidoc parser for Text::Markup

## Name

Text::Markup::Asciidoc - Asciidoc parser for Text::Markup

## Synopsis

```
  use Text::Markup;
  my $html = Text::Markup->new->parse(file => 'hello.adoc');
  my $raw = Text::Markup->new->parse(
      file    => 'hello.adoc',
      options => [raw => 1],
  );
```

## Description

This is the Asciidoc \<https://asciidoc.org/\> parser for Text::Markup. It depends on the `"asciidoc"` \<https://asciidoc-py.github.io\> command-line application. See the installation docs \<https://asciidoc-py.github.io/INSTALL.html\> for details, or use the command `"pip3 install asciidoc"`.

Text::Markup::Asciidoc recognizes files with the following extensions as Asciidoc:

- *.asciidoc*

  - *.asc*

  - *.adoc*

  To change it the files it recognizes, load this module directly and pass a regular expression matching the desired extension(s), like so:

```
  use Text::Markup::Asciidoc qr{ski?doc};
```

Normally this parser returns the output of `"asciidoc"` wrapped in a minimal HTML page skeleton. If you would prefer to just get the exact output returned by `"asciidoc"`, you can pass in a true value for the `"raw"` option.

## Author

David E. Wheeler \<david@justatheory.com\>

## Copyright and License

Copyright (c) 2012-2024 David E. Wheeler. Some Rights Reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.