mdbook-asciidoc
| Crates.io | mdbook-asciidoc |
| lib.rs | mdbook-asciidoc |
| version | 0.1.0 |
| source | src |
| created_at | 2023-10-21 06:30:30.586034 |
| updated_at | 2023-10-21 06:30:30.586034 |
| description | mdBook backend for AsciiDoc generation |
| homepage | |
| repository | https://github.com/daviddrysdale/mdbook-asciidoc |
| max_upload_size | |
| id | 1009849 |
| size | 281,279 |
David Drysdale (daviddrysdale)
documentation
README
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>