/ 
Text-AsciidocDown-0.1.0
/ Text::AsciidocDown::Parser

NAME

Text::AsciidocDown::Parser - AsciiDoc-to-Markdown parser engine

SYNOPSIS

use Text::AsciidocDown::Parser;

my $markdown = Text::AsciidocDown::Parser::convert($asciidoc, \%opts);

DESCRIPTION

This module implements the core AsciiDoc-to-Markdown conversion logic for Text::AsciidocDown. It is not intended for direct use; callers should use the OO interface provided by Text::AsciidocDown.

INTERFACE

convert

my $markdown = Text::AsciidocDown::Parser::convert($asciidoc, \%opts);

Converts AsciiDoc text to Markdown.

Options:

attributes - HashRef of AsciiDoc attributes for substitution

Returns the converted Markdown string.

SUPPORTED FEATURES

  • Document title (= Level 0 Heading)

  • Section headings (== through ======)

  • Attribute entries (:name: value)

  • Header lines (author, revision)

  • Conditional preprocessing (ifdef::[], ifndef::[], endif::[])

  • Unordered lists (*, -)

  • Ordered lists (., 1.)

  • Description lists (term:: description)

  • Q&A lists (qanda style)

  • Code blocks (----, ....)

  • Literal paragraphs (indented)

  • Quote blocks (____)

  • Admonition blocks (NOTE, TIP, IMPORTANT, WARNING, CAUTION)

  • Passthrough blocks (++++)

  • Tables (|===)

  • Thematic breaks (''', ***, ---)

  • Block images (image::[])

  • TOC and page break directives

AUTHOR

Sandor Patocs

LICENSE

Same terms as Perl itself.