#mdbook #asciidoc #back-end #generation

app mdbook-asciidoc

mdBook backend for AsciiDoc generation

1 unstable release

0.1.0 Oct 21, 2023

#1647 in Text processing

Apache-2.0

210KB
865 lines

mdbook-asciidoc

A backend for mdbook that outputs AsciiDoc.

Installation

To use, install the tool

cargo install mdbook-asciidoc

and add it as a backend in book.toml:

[preprocessor.asciidoc]

Configuration

The following configuration values can be set in book.toml.

Name Type Default Description
allow-asciidoc boolean false Cope with some AsciiDoc constructs included in the Markdown source when set.
heading-offset integer 0 Extra offset to apply to heading levels.
skip-chapters string "" Comma-separated list of filenames to ignore when generating AsciiDoc.

AsciiDoc Passthrough

When the allow-asciidoc config option is set, AsciiDoc in the source document can be included as the content attribute of an <asciidoc> HTML-like tag, to prevent it being interpreted by Markdown.

For example, four underscores are used in AsciiDoc to delimit block quotations, but would also be interpreted as a horizontal rule in Markdown if not escaped:

    <asciidoc content='____'></asciidoc>

Dependencies

~15–27MB
~397K SLoC